HGL::Type::ReferenceParam Class Reference
[Types]

#include <referenceparam.h>

Inheritance diagram for HGL::Type::ReferenceParam:

[legend]

List of all members.

Public Member Functions
virtual const IType *	findReference (bool recache=false) const
virtual const SerialID &	getSerialID () const
	Gets the serialization ID of the object.
virtual	operator float () const throw (Exception::InvalidExpressionException, Exception::ReferenceException)
	Converts the type into a float.
virtual const std::string	toString () const
	Gets the string representation of a parameter type.

---

Detailed Description

Author:

Heiko Schäfer <heiko@hgl.rangun.de>

---

Member Function Documentation

const HGL::IType * ReferenceParam::findReference

(

bool

recache = false

)

const [virtual]

Searches the tree for the associated reference.

Note:

To check if a reference was actually found use IType::isNull

See also:

IType::isNull

Returns:

an IType to a reference or the special NullType if not found

if the reference itself is a ReferenceParam, it will tried to get resolved too.

Reimplemented from HGL::Type::ReferenceHolderBase.

Reimplemented in HGL::Type::ExpressionParam.

const HGL::Type::SerialID & ReferenceParam::getSerialID

(

)

const [virtual]

Gets the serialization ID of the object.

Returns:

the serialization ID of the object

Implements HGL::IType.

Reimplemented in HGL::Type::ExpressionParam, and HGL::Type::NamedParam.

ReferenceParam::operator float

(

)

const throw (Exception::InvalidExpressionException, Exception::ReferenceException) [virtual]

Converts the type into a float.

Returns:

the type as float

Reimplemented from HGL::Type::TypeBase.

const std::string ReferenceParam::toString

(

)

const [virtual]

Gets the string representation of a parameter type.

Returns:

the string representation of a parameter type

Implements HGL::Type::ParamBase.

Reimplemented in HGL::Type::ExpressionParam.