openvrml::mfvec3f Class Reference

A 3-component vector array node field value. More...

#include <openvrml/field_value.h>

Inheritance diagram for openvrml::mfvec3f:

List of all members.


Public Types

typedef std::vector< vec3fvalue_type
 Type of value.

Public Member Functions

 mfvec3f (std::vector< vec3f >::size_type n=0, const vec3f &value=vec3f()) throw ( std::bad_alloc )
 Construct.
 mfvec3f (const value_type &value) throw ( std::bad_alloc )
 Construct.
 mfvec3f (const mfvec3f &mfv)
 Construct a copy.
virtual ~mfvec3f () throw ()
 Destroy.
mfvec3foperator= (const mfvec3f &mfv) throw ( std::bad_alloc )
 Assign.
const value_typevalue () const throw ()
 Access.
void value (const value_type &val) throw ( std::bad_alloc )
 Mutate.
void swap (mfvec3f &mfv) throw ()
 Swap.

Static Public Attributes

static const type_id field_value_type_id = mfvec3f_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 mfvec3fdo_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 mfvec3f &lhs, const mfvec3f &rhs) throw()
 Compare for equality.
bool operator!= (const mfvec3f &lhs, const mfvec3f &rhs) throw()
 Compare for inequality.
template<> void swap (openvrml::mfvec3f &a, openvrml::mfvec3f &b)
 Swap the values of a and b.

Detailed Description

A 3-component vector array node field value.

Model of
Field Value

Member Typedef Documentation


Constructor & Destructor Documentation

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

Construct.

Creates an mfvec3f with n copies of value.

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

openvrml::mfvec3f::mfvec3f ( 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::mfvec3f::mfvec3f ( const mfvec3f mfv  ) 

Construct a copy.

Parameters:
[in] mfv the instance to copy.

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

Destroy.

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


Member Function Documentation

openvrml::mfvec3f & openvrml::mfvec3f::operator= ( const mfvec3f mfv  )  throw ( std::bad_alloc )

Assign.

Parameters:
[in] mfv the value to assign.
Returns:
a reference to the instance.
Exceptions:
std::bad_alloc if memory allocation fails.

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

Access.

Returns:
the vector values.

Reimplemented from openvrml::field_value.

void openvrml::mfvec3f::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::mfvec3f::swap ( mfvec3f mfv  )  throw ()

Swap.

Parameters:
[in,out] mfv the value to swap with this one.

std::auto_ptr< openvrml::field_value > openvrml::mfvec3f::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::mfvec3f & openvrml::mfvec3f::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 mfvec3f object.
std::bad_alloc if memory allocation fails.

Implements openvrml::field_value.

openvrml::field_value::type_id openvrml::mfvec3f::do_type (  )  const throw () [private, virtual]

Get the field_value::type_id associated with this class.

Returns:
field_value::mfvec3f_id.

Implements openvrml::field_value.

void openvrml::mfvec3f::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 mfvec3f lhs,
const mfvec3f 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 mfvec3f lhs,
const mfvec3f 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::mfvec3f a,
openvrml::mfvec3f b 
) [related]

Swap the values of a and b.

Does not throw.

Parameters:
[in,out] a 
[in,out] b 


Member Data Documentation