openvrml::mfcolor Class Reference

A color array node field value. More...

#include <openvrml/field_value.h>

Inheritance diagram for openvrml::mfcolor:

[legend]

List of all members.

Public Types
typedef std::vector< color >	value_type
	The type of value.
Public Member Functions
	mfcolor (std::vector< color >::size_type n=0, const color &value=color()) throw ( std::bad_alloc )
	Construct.
	mfcolor (const value_type &value) throw ( std::bad_alloc )
	Construct.
	mfcolor (const mfcolor &mfc)
	Construct a copy.
virtual	~mfcolor () throw ()
	Destroy.
mfcolor &	operator= (const mfcolor &mfc) throw ( std::bad_alloc )
	Assign.
const value_type &	value () const throw ()
	Access.
void	value (const value_type &val) throw ( std::bad_alloc )
	Mutate.
void	swap (mfcolor &mfc) throw ()
	Swap.
Static Public Attributes
static const type_id	field_value_type_id = mfcolor_id
	field_value::type_id for this class.
Private Member Functions
virtual std::auto_ptr < field_value >	do_clone () const throw ( std::bad_alloc )
	Polymorphically construct a copy.
virtual mfcolor &	do_assign (const field_value &value) throw ( std::bad_cast , std::bad_alloc )
	Virtual assignment.
virtual type_id	do_type () const throw ()
	Get the field_value::type_id associated with this class.
virtual void	print (std::ostream &) const
	Print to an output stream.
Related Functions
(Note that these are not member functions.)
bool	operator== (const mfcolor &lhs, const mfcolor &rhs) throw()
	Compare for equality.
bool	operator!= (const mfcolor &lhs, const mfcolor &rhs) throw()
	Compare for inequality.
template<> void	swap (openvrml::mfcolor &a, openvrml::mfcolor &b)
	Swap the values of a and b.

---

Detailed Description

A color array node field value.

Model of

Field Value

---

Member Typedef Documentation

openvrml::mfcolor::value_type

The type of value.

---

Constructor & Destructor Documentation

openvrml::mfcolor::mfcolor	(	std::vector< color >::size_type	n = 0,
		const color &	value = color()
	)			throw ( std::bad_alloc ) [explicit]

Construct.

Creates an mfcolor with n copies of value.

Parameters:

[in]	n	the number elements in the mfcolor.
[in]	value	used to initialize the mfcolor.

Exceptions:

std::bad_alloc

if memory allocation fails.

Postcondition:

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

openvrml::mfcolor::mfcolor

(

const value_type &

value

)

throw ( std::bad_alloc ) [inline, explicit]

Construct.

Parameters:

[in]

value

initial value.

Exceptions:

std::bad_alloc

if memory allocation fails.

openvrml::mfcolor::mfcolor

(

const mfcolor &

mfc

)

Construct a copy.

Parameters:

[in]

mfc

the instance to copy.

openvrml::mfcolor::~mfcolor

(

)

throw () [virtual]

Destroy.

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

---

Member Function Documentation

openvrml::mfcolor & openvrml::mfcolor::operator=

(

const mfcolor &

mfc

)

throw ( std::bad_alloc )

Assign.

Parameters:

[in]

mfc

the value to assign.

Returns:

a reference to the instance.

Exceptions:

std::bad_alloc

if memory allocation fails.

const openvrml::mfcolor::value_type & openvrml::mfcolor::value

(

)

const throw ()

Access.

Returns:

the color values.

Reimplemented from openvrml::field_value.

void openvrml::mfcolor::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::mfcolor::swap

(

mfcolor &

mfc

)

throw ()

Swap.

Parameters:

[in,out]

mfc

the value to swap with this one.

std::auto_ptr< openvrml::field_value > openvrml::mfcolor::do_clone

(

)

const throw ( std::bad_alloc ) [private, virtual]

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::mfcolor & openvrml::mfcolor::do_assign

(

const field_value &

value

)

throw ( std::bad_cast , std::bad_alloc ) [private, virtual]

Virtual assignment.

Returns:

a reference to the object.

Exceptions:

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

Implements openvrml::field_value.

openvrml::field_value::type_id openvrml::mfcolor::do_type

(

)

const throw () [private, virtual]

Get the field_value::type_id associated with this class.

Returns:

field_value::mfcolor.

Implements openvrml::field_value.

void openvrml::mfcolor::print

(

std::ostream &

out

)

const [private, virtual]

Print to an output stream.

Parameters:

[in,out]

out

an output stream.

Implements openvrml::field_value.

---

Friends And Related Function Documentation

bool operator==	(	const mfcolor &	lhs,
		const mfcolor &	rhs
	)			throw() [related]

Compare for equality.

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 mfcolor &	lhs,
		const mfcolor &	rhs
	)			throw() [related]

Compare for inequality.

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::mfcolor &	a,
		openvrml::mfcolor &	b
	)			[related]

Swap the values of a and b.

Does not throw.

Parameters:

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

---

Member Data Documentation

const openvrml::field_value::type_id openvrml::mfcolor::field_value_type_id = mfcolor_id [static]

field_value::type_id for this class.