Home	Download	Screen shots	Discussion	Documentation

openvrml::sfstring Class Reference
[Field Values]

Inheritance diagram for openvrml::sfstring:

[legend]

List of all members.

---

Detailed Description

A string node field value.

Model of

FieldValue

Public Types
typedef std::string	value_type
	Type of value.
Public Member Functions
	sfstring (const std::string &value=std::string()) throw (std::bad_alloc)
	Construct.
virtual	~sfstring () throw ()
	Destroy.
virtual std::auto_ptr < field_value >	clone () const throw (std::bad_alloc)
	Virtual copy constructor.
virtual field_value &	assign (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::string	value
	String value.
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 sfstring &lhs, const sfstring &rhs) throw()
	Compare for equality.
bool	operator!= (const sfstring &lhs, const sfstring &rhs) throw()
	Compare for inequality.

---

Member Typedef Documentation

openvrml::sfstring::value_type

Type of value.

---

Constructor & Destructor Documentation

openvrml::sfstring::sfstring

(

const std::string &

value = std::string()

)

throw (std::bad_alloc) [explicit]

Construct.

Parameters:

value

Exceptions:

std::bad_alloc

if memory allocation fails.

openvrml::sfstring::~sfstring

(

)

throw () [virtual]

Destroy.

---

Member Function Documentation

std::auto_ptr< field_value > openvrml::sfstring::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::sfstring::assign

(

const field_value &

value

)

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

Virtual assignment.

Parameters:

value

the new value to give the object.

Returns:

a reference to the object.

Exceptions:

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

Implements openvrml::field_value.

field_value::type_id openvrml::sfstring::type

(

)

const throw () [virtual]

Get the field_value::type_id associated with this class.

Returns:

field_value::sfstring.

Implements openvrml::field_value.

void openvrml::sfstring::print

(

std::ostream &

out

)

const [private, virtual]

Print to an output stream.

Parameters:

out

an output stream.

Implements openvrml::field_value.

---

Friends And Related Function Documentation

bool operator==	(	const sfstring &	lhs,
		const sfstring &	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 sfstring &	lhs,
		const sfstring &	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.

---

Member Data Documentation

openvrml::sfstring::value

String value.