openvrml::sfnode Class Reference

A node field value to hold a single node reference. More...

#include <openvrml/field_value.h>

Inheritance diagram for openvrml::sfnode:

Public Types

typedef boost::intrusive_ptr< node > value_type
 Type of value. More...
 
- Public Types inherited from openvrml::field_value

Public Member Functions

 sfnode (const value_type &node=value_type(0)) throw ()
 Construct. More...
 
 sfnode (const sfnode &sfn)
 Construct a copy. More...
 
virtual ~sfnode () throw ()
 Destroy. More...
 
sfnodeoperator= (const sfnode &sfn) throw ( std::bad_alloc )
 Assign. More...
 
const value_typevalue () const throw ()
 Access. More...
 
void value (const value_type &val) throw ( std::bad_alloc )
 Mutate. More...
 
void swap (sfnode &sfn) throw ()
 Swap. More...
 
- Public Member Functions inherited from openvrml::field_value
virtual ~field_value ()=0 throw ()
 Destroy. More...
 
std::auto_ptr< field_valueclone () const throw ( std::bad_alloc )
 Polymorphically construct a copy. More...
 
field_valueassign (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 = sfnode_id
 field_value::type_id for this class. More...
 

Private Member Functions

virtual std::auto_ptr< field_valuedo_clone () const throw ( std::bad_alloc )
 Polymorphically construct a copy. More...
 
virtual sfnodedo_assign (const field_value &value) throw ( std::bad_cast )
 Virtual assignment. More...
 
virtual type_id do_type () const throw ()
 Get the field_value::type_id associated with this 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 sfnode &lhs, const sfnode &rhs) throw()
 Compare for equality. More...
 
bool operator!= (const sfnode &lhs, const sfnode &rhs) throw()
 Compare for inequality. More...
 
template<> void swap (openvrml::sfnode &a, openvrml::sfnode &b)
 Swap the values of a and b. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from openvrml::field_value
static std::auto_ptr< field_valuecreate (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 node field value to hold a single node reference.

Model of
Field Value

Member Typedef Documentation

Constructor & Destructor Documentation

openvrml::sfnode::sfnode ( const value_type node = value_type(0))
throw (
)
explicit

Construct.

Parameters
[in]nodea pointer to a node.
openvrml::sfnode::sfnode ( const sfnode sfn)

Construct a copy.

Parameters
[in]sfnthe instance to copy.
openvrml::sfnode::~sfnode ( )
throw (
)
virtual

Destroy.

Member Function Documentation

openvrml::sfnode & openvrml::sfnode::operator= ( const sfnode sfn)
throw (std::bad_alloc
)

Assign.

Parameters
[in]sfnthe value to assign.
Returns
a reference to the instance.
Exceptions
std::bad_allocif memory allocation fails.
const openvrml::sfnode::value_type & openvrml::sfnode::value ( ) const
throw (
)

Access.

Returns
the node pointer.
void openvrml::sfnode::value ( const value_type val)
throw (std::bad_alloc
)

Mutate.

Parameters
[in]valthe new value.
Exceptions
std::bad_allocif memory allocation fails.
void openvrml::sfnode::swap ( sfnode sfn)
throw (
)

Swap.

Parameters
[in,out]sfnthe value to swap with this one.
std::auto_ptr< openvrml::field_value > openvrml::sfnode::do_clone ( ) const
throw (std::bad_alloc
)
privatevirtual

Polymorphically construct a copy.

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

Implements openvrml::field_value.

Reimplemented in openvrml::node_impl_util::abstract_node< Derived >::exposedfield< openvrml::sfnode >.

openvrml::sfnode & openvrml::sfnode::do_assign ( const field_value value)
throw (std::bad_cast
)
privatevirtual

Virtual assignment.

Parameters
[in]valuethe new value to give the object.
Returns
a reference to the object.
Exceptions
std::bad_castif value is not an sfnode.

Implements openvrml::field_value.

openvrml::field_value::type_id openvrml::sfnode::do_type ( ) const
throw (
)
privatevirtual

Get the field_value::type_id associated with this class.

Returns
field_value::sfnode.

Implements openvrml::field_value.

void openvrml::sfnode::print ( std::ostream &  out) const
privatevirtual

Print to an output stream.

Parameters
[in,out]outan output stream.

Implements openvrml::field_value.

Friends And Related Function Documentation

bool operator== ( const sfnode lhs,
const sfnode rhs 
)
throw(
)
related

Compare for equality.

Parameters
[in]lhsleft-hand operand.
[in]rhsright-hand operand.
Returns
true if lhs and rhs have the same value; false otherwise.
bool operator!= ( const sfnode lhs,
const sfnode rhs 
)
throw(
)
related

Compare for inequality.

Parameters
[in]lhsleft-hand operand.
[in]rhsright-hand operand.
Returns
true if lhs and rhs do not have the same value; false otherwise.
template<> void swap ( openvrml::sfnode a,
openvrml::sfnode 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::sfnode::field_value_type_id = sfnode_id
static

field_value::type_id for this class.