openvrml::sfdouble Class Reference

A single precision doubleing point node field value. More...

#include <openvrml/field_value.h>

Inheritance diagram for openvrml::sfdouble:

List of all members.


Public Types

typedef double value_type
 Type of value.

Public Member Functions

 sfdouble (double value=0.0) throw ()
 Construct.
 sfdouble (const sfdouble &sfd)
 Construct a copy.
virtual ~sfdouble () throw ()
 Destroy.
sfdoubleoperator= (const sfdouble &sfd) throw ( std::bad_alloc )
 Assign.
const value_typevalue () const throw ()
 Access.
void value (const value_type &val) throw ( std::bad_alloc )
 Mutate.
void swap (sfdouble &sfd) throw ()
 Swap.

Static Public Attributes

static const type_id field_value_type_id = sfdouble_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 sfdoubledo_assign (const field_value &value) throw ( std::bad_cast )
 Virtual assignment.
virtual type_id do_type () const throw ()
 Get the field_value::type_id associated with this class.
virtual void print (std::ostream &out) const
 Print to an output stream.

Related Functions

(Note that these are not member functions.)

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

Detailed Description

A single precision doubleing point node field value.

Model of
Field Value

Member Typedef Documentation


Constructor & Destructor Documentation

openvrml::sfdouble::sfdouble ( double  value = 0.0  )  throw () [explicit]

Construct.

Parameters:
[in] value initial value

openvrml::sfdouble::sfdouble ( const sfdouble sfd  ) 

Construct a copy.

Parameters:
[in] sfd the instance to copy.

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

Destroy.


Member Function Documentation

openvrml::sfdouble & openvrml::sfdouble::operator= ( const sfdouble sfd  )  throw ( std::bad_alloc )

Assign.

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

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

Access.

Returns:
the double-precision value.

Reimplemented from openvrml::field_value.

void openvrml::sfdouble::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::sfdouble::swap ( sfdouble sfd  )  throw ()

Swap.

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

std::auto_ptr< openvrml::field_value > openvrml::sfdouble::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::sfdouble & openvrml::sfdouble::do_assign ( const field_value value  )  throw ( std::bad_cast ) [private, virtual]

Virtual assignment.

Parameters:
[in] value the new value to give the object.
Returns:
a reference to the object.
Exceptions:
std::bad_cast if value is not an sfdouble.

Implements openvrml::field_value.

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

Get the field_value::type_id associated with this class.

Returns:
field_value::sfdouble.

Implements openvrml::field_value.

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

Swap the values of a and b.

Does not throw.

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


Member Data Documentation