openvrml::mfnode Class Reference
[Field Values]

Inheritance diagram for openvrml::mfnode:
[legend]
List of all members.

Detailed Description

A node reference array node field value.

Model of
FieldValue


Public Types

typedef std::vector< node_ptrvalue_type
 Type of value.

Public Member Functions

 mfnode (std::vector< node_ptr >::size_type n=0, const node_ptr &value=node_ptr()) throw (std::bad_alloc)
 Construct.
 mfnode (const std::vector< node_ptr > &value) throw (std::bad_alloc)
 Construct.
template<typename InputIterator>
 mfnode (InputIterator first, InputIterator last)
 Create an mfnode with a copy of a range.
virtual ~mfnode () throw ()
 Destroy.
virtual std::auto_ptr< field_valueclone () const throw (std::bad_alloc)
 Virtual copy constructor.
virtual field_valueassign (const field_value &value) throw (std::bad_cast, std::bad_alloc)
 Virtual assignment.
virtual type_id type () const throw ()
 Get the field_value::type_id associated with this class.

Public Attributes

std::vector< node_ptrvalue
 Node references.

Private Member Functions

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

Related Functions

(Note that these are not member functions.)

bool operator== (const mfnode &lhs, const mfnode &rhs) throw()
 Compare for equality.
bool operator!= (const mfnode &lhs, const mfnode &rhs) throw()
 Compare for inequality.
template<> void swap (openvrml::mfnode &a, openvrml::mfnode &b)
 Swap the values of a and b.

Member Typedef Documentation

Type of value.


Constructor & Destructor Documentation

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

Construct.

Creates an mfnode with n copies of value.

Parameters:
n the number elements in the mfnode.
value used to initialize the mfnode.
Exceptions:
std::bad_alloc if memory allocation fails.
Postcondition:
size is n. Every element is a copy of value.

openvrml::mfnode::mfnode ( const std::vector< node_ptr > &  value  )  throw (std::bad_alloc) [explicit]

Construct.

Parameters:
value initial value.
Exceptions:
std::bad_alloc if memory allocation fails.

template<typename InputIterator>
openvrml::mfnode::mfnode ( InputIterator  first,
InputIterator  last 
)

Create an mfnode with a copy of a range.

Creates an mfnode with a value that is a copy of the range [first, last).

Parameters:
first an iterator pointing to the beginning of the range.
last an iterator pointing one past the end of the range.

openvrml::mfnode::~mfnode (  )  throw () [virtual]

Destroy.

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


Member Function Documentation

std::auto_ptr< field_value > openvrml::mfnode::clone (  )  const throw (std::bad_alloc) [virtual]

Virtual copy constructor.

Returns:
a pointer to a copy of the object.
Exceptions:
std::bad_alloc if memory allocation fails.

Implements openvrml::field_value.

field_value & openvrml::mfnode::assign ( const field_value value  )  throw (std::bad_cast, std::bad_alloc) [virtual]

Virtual assignment.

Returns:
a reference to the object.
Exceptions:
std::bad_cast if value is not an mfnode object.
std::bad_alloc if memory allocation fails.

Implements openvrml::field_value.

field_value::type_id openvrml::mfnode::type (  )  const throw () [virtual]

Get the field_value::type_id associated with this class.

Returns:
field_value::mfnode_id.

Implements openvrml::field_value.

void openvrml::mfnode::print ( std::ostream &  out  )  const [private, virtual]

Print to an output stream.

Any null elements in the mfnode will not get printed; VRML97 syntax does not accommodate NULL in an mfnode.

Parameters:
out an output stream.

Implements openvrml::field_value.


Friends And Related Function Documentation

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

Compare for equality.

Parameters:
lhs left-hand operand.
rhs right-hand operand.
Returns:
true if lhs and rhs have the same value; false otherwise.

bool operator!= ( const mfnode lhs,
const mfnode rhs 
) throw() [related]

Compare for inequality.

Parameters:
lhs left-hand operand.
rhs right-hand operand.
Returns:
true if lhs and rhs do not have the same value; false otherwise.

template<> void swap ( openvrml::mfnode a,
openvrml::mfnode b 
) [related]

Swap the values of a and b.

Does not throw.

Parameters:
a 
b 


Member Data Documentation

Node references.