A float array node field value. More...

#include <openvrml/field_value.h>

Inheritance diagram for openvrml::mffloat:

Public Types
typedef std::vector< float >	value_type
	Type of value. More...

Public Types inherited from openvrml::field_value
enum	type_id { invalid_type_id, sfbool_id, sfcolor_id, sfcolorrgba_id, sffloat_id, sfdouble_id, sfimage_id, sfint32_id, sfnode_id, sfrotation_id, sfstring_id, sftime_id, sfvec2f_id, sfvec2d_id, sfvec3f_id, sfvec3d_id, mfbool_id, mfcolor_id, mfcolorrgba_id, mffloat_id, mfdouble_id, mfimage_id, mfint32_id, mfnode_id, mfrotation_id, mfstring_id, mftime_id, mfvec2f_id, mfvec2d_id, mfvec3f_id, mfvec3d_id }
	Used to identify field_value types. More...

Public Member Functions
	mffloat (std::vector< float >::size_type n=0, float value=0.0f) throw ( std::bad_alloc )
	Construct. More...

	mffloat (const value_type &value) throw ( std::bad_alloc )
	Construct. More...

	mffloat (const mffloat &mff)
	Construct a copy. More...

virtual	~mffloat () throw ()
	Destroy. More...

mffloat &	operator= (const mffloat &mff) throw ( std::bad_alloc )
	Assign. More...

const value_type &	value () const throw ()
	Access. More...

void	value (const value_type &val) throw ( std::bad_alloc )
	Mutate. More...

void	swap (mffloat &mff) throw ()
	Swap. More...

Public Member Functions inherited from openvrml::field_value
virtual	~field_value ()=0 throw ()
	Destroy. More...

std::auto_ptr< field_value >	clone () const throw ( std::bad_alloc )
	Polymorphically construct a copy. More...

field_value &	assign (const field_value &value) throw ( std::bad_cast , std::bad_alloc )
	Virtual assignment. More...

type_id	type () const throw ()
	Get the field type. More...

template<typename FieldValue >
const FieldValue::value_type &	value () const throw ()
	Access. More...

template<typename FieldValue >
void	value (const typename FieldValue::value_type &val) throw ( std::bad_alloc )
	Mutate. More...

template<typename FieldValue >
void	swap (FieldValue &val) throw ()
	Swap. More...

Static Public Attributes
static const type_id	field_value_type_id = mffloat_id
	`field_value::type_id` for this class. More...

Private Member Functions
virtual std::auto_ptr < field_value >	do_clone () const throw ( std::bad_alloc )
	Polymorphically construct a copy. More...

virtual mffloat &	do_assign (const field_value &value) throw ( std::bad_cast , std::bad_alloc )
	Virtual assignment. More...

virtual type_id	do_type () const throw ()
	Get the type identifier for the class. More...

virtual void	print (std::ostream &) const
	Print to an output stream. More...

Related Functions
(Note that these are not member functions.)
bool	operator== (const mffloat &lhs, const mffloat &rhs) throw()
	Compare for equality. More...

bool	operator!= (const mffloat &lhs, const mffloat &rhs) throw()
	Compare for inequality. More...

template<> void	swap (openvrml::mffloat &a, openvrml::mffloat &b)
	Swap the values of `a` and `b`. More...

Related Functions inherited from openvrml::field_value
std::ostream &	operator<< (std::ostream &out, const field_value &value)
	Stream output. More...

std::ostream &	operator<< (std::ostream &out, const field_value::type_id type_id)
	Stream output. More...

std::istream &	operator>> (std::istream &in, field_value::type_id &type_id)
	Stream input. More...

Additional Inherited Members
Static Public Member Functions inherited from openvrml::field_value
static std::auto_ptr< field_value >	create (type_id type) throw ( std::bad_alloc )
	Create a default instance of the type specified by `type`. More...

Protected Member Functions inherited from openvrml::field_value
template<typename ValueType >
	field_value (const ValueType &value, const value_type_constructor_tag &) throw ( std::bad_alloc )
	Construct. More...

	field_value (const field_value &value) throw ( std::bad_alloc )
	Construct a copy. More...

template<typename FieldValue >
FieldValue &	operator= (const FieldValue &fv) throw ( std::bad_alloc )
	Assignment operator. More...

Detailed Description

A float array node field value.

Model of: Field Value

Member Typedef Documentation

openvrml::mffloat::value_type

Type of value.

Constructor & Destructor Documentation

openvrml::mffloat::mffloat	(	std::vector< float >::size_type	n = `0`,
		float	value = `0.0f`
	)
throw	(	std::bad_alloc
	)

explicit

Construct.

Creates an mffloat with n copies of value.

Parameters

[in]	n	the number of elements in the `mffloat`.
[in]	value	used to initialize the `mffloat`.

Exceptions

std::bad_alloc if memory allocation fails.

Postcondition: size is n. Every element is a copy of value.

openvrml::mffloat::mffloat	(	const value_type &	value	)
throw	(	std::bad_alloc
	)

inlineexplicit

Construct.

Parameters

[in] value initial value.

Exceptions

std::bad_alloc if memory allocation fails.

openvrml::mffloat::mffloat ( const mffloat & mff )

Construct a copy.

Parameters

[in] mff the instance to copy.

openvrml::mffloat::~mffloat	(	)
throw	(
	)

virtual

Destroy.

Each of the mffloat's value elements is destroyed, and memory allocated for them (if any) is deallocated.

Member Function Documentation

openvrml::mffloat & openvrml::mffloat::operator=	(	const mffloat &	mff	)
throw	(	std::bad_alloc
	)

Assign.

Parameters

[in] mff the value to assign.

Returns: a reference to the instance.

Exceptions

std::bad_alloc if memory allocation fails.

const openvrml::mffloat::value_type & openvrml::mffloat::value	(	)	const
throw	(
	)

Access.

Returns: the floating point values.

void openvrml::mffloat::value	(	const value_type &	val	)
throw	(	std::bad_alloc
	)

Mutate.

Parameters

[in] val the new value.

Exceptions

std::bad_alloc if memory allocation fails.

void openvrml::mffloat::swap	(	mffloat &	mff	)
throw	(
	)

Swap.

Parameters

[in,out] mff the value to swap with this one.

std::auto_ptr< openvrml::field_value > openvrml::mffloat::do_clone	(		)	const
throw	(	std::bad_alloc
	)

privatevirtual

Polymorphically construct a copy.

Returns: a pointer to a copy of the object.

Exceptions

std::bad_alloc if memory allocation fails.

Implements openvrml::field_value.

openvrml::mffloat & openvrml::mffloat::do_assign	(	const field_value &	value	)
throw	(	std::bad_cast ,
		std::bad_alloc
	)

privatevirtual

Virtual assignment.

Returns: a reference to the object.

Exceptions

std::bad_cast	if `value` is not an mffloat object.
std::bad_alloc	if memory allocation fails.

Implements openvrml::field_value.

openvrml::field_value::type_id openvrml::mffloat::do_type	(	)	const
throw	(
	)

privatevirtual

Get the type identifier for the class.

Returns: field_value::mffloat_id.

Implements openvrml::field_value.

void openvrml::mffloat::print ( std::ostream & out ) const

privatevirtual

Print to an output stream.

Parameters

[in,out] out an output stream.

Implements openvrml::field_value.

Friends And Related Function Documentation

bool operator==	(	const mffloat &	lhs,
		const mffloat &	rhs
	)
throw	(
	)

Parameters

[in]	lhs	left-hand operand.
[in]	rhs	right-hand operand.

Returns: true if lhs and rhs have the same value; false otherwise.

bool operator!=	(	const mffloat &	lhs,
		const mffloat &	rhs
	)
throw	(
	)

Parameters

[in]	lhs	left-hand operand.
[in]	rhs	right-hand operand.

Returns: true if lhs and rhs do not have the same value; false otherwise.

template<> void swap	(	openvrml::mffloat &	a,
		openvrml::mffloat &	b
	)

Does not throw.

Parameters

[in,out]	a
[in,out]	b

Member Data Documentation

const openvrml::field_value::type_id openvrml::mffloat::field_value_type_id = mffloat_id

static

field_value::type_id for this class.

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Related Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation