dtDAL::NamedGenericParameter< ParamType > Class Template Reference

#include <namedparameter.h>

Inheritance diagram for dtDAL::NamedGenericParameter< ParamType >:

List of all members.

Public Member Functions
	NamedGenericParameter (const std::string &name, const ParamType &defaultValue, bool isList=false)
void	SetNumberPrecision (unsigned int precision)
	Sets the precision of floating point number as they are converted to and from string values.
unsigned int	GetNumberPrecision () const
	Gets the current floating point precision value on this parameter.
virtual void	CopyFrom (const NamedParameter &otherParam)
	Parameters: otherParam  the message parameter to make this one match.
virtual void	SetValue (const ParamType &value)
virtual const ParamType &	GetValue () const
const std::vector< ParamType > &	GetValueList () const
std::vector< ParamType > &	GetValueList ()
void	SetValueList (const std::vector< ParamType > &newValues)
virtual void	ToDataStream (dtUtil::DataStream &stream) const
virtual void	FromDataStream (dtUtil::DataStream &stream)
virtual const std::string	ToString () const
virtual bool	FromString (const std::string &value)
	Returns: true if it was able to assign the value based on the string or false if not.
virtual bool	operator== (const NamedParameter &toCompare) const
Protected Member Functions
virtual	~NamedGenericParameter ()
	Keep destructors protected to ensure property smart pointer management.

template<class ParamType>
class dtDAL::NamedGenericParameter< ParamType >

---

Constructor & Destructor Documentation

template<class ParamType>

dtDAL::NamedGenericParameter< ParamType >::NamedGenericParameter	(	const std::string &	name,
		const ParamType &	defaultValue,
		bool	isList = false
	)			[inline]

template<class ParamType>

virtual dtDAL::NamedGenericParameter< ParamType >::~NamedGenericParameter

(

)

[inline, protected, virtual]

Keep destructors protected to ensure property smart pointer management.

---

Member Function Documentation

template<class ParamType>

void dtDAL::NamedGenericParameter< ParamType >::SetNumberPrecision

(

unsigned int

precision

)

[inline]

Sets the precision of floating point number as they are converted to and from string values.

Parameters:

precision

The amount of numeric percision.

Note:

This value defaults to 16.

template<class ParamType>

unsigned int dtDAL::NamedGenericParameter< ParamType >::GetNumberPrecision

(

)

const [inline]

Gets the current floating point precision value on this parameter.

Returns:

The current number precision.

template<class ParamType>

virtual void dtDAL::NamedGenericParameter< ParamType >::CopyFrom

(

const NamedParameter &

otherParam

)

[inline, virtual]

Parameters:

otherParam

the message parameter to make this one match.

Implements dtDAL::NamedParameter.

template<class ParamType>

virtual void dtDAL::NamedGenericParameter< ParamType >::SetValue

(

const ParamType &

value

)

[inline, virtual]

template<class ParamType>

virtual const ParamType& dtDAL::NamedGenericParameter< ParamType >::GetValue

(

)

const [inline, virtual]

template<class ParamType>

const std::vector<ParamType>& dtDAL::NamedGenericParameter< ParamType >::GetValueList

(

)

const [inline]

template<class ParamType>

std::vector<ParamType>& dtDAL::NamedGenericParameter< ParamType >::GetValueList

(

)

[inline]

template<class ParamType>

void dtDAL::NamedGenericParameter< ParamType >::SetValueList

(

const std::vector< ParamType > &

newValues

)

[inline]

template<class ParamType>

virtual void dtDAL::NamedGenericParameter< ParamType >::ToDataStream

(

dtUtil::DataStream &

stream

)

const [inline, virtual]

Implements dtDAL::NamedParameter.

template<class ParamType>

virtual void dtDAL::NamedGenericParameter< ParamType >::FromDataStream

(

dtUtil::DataStream &

stream

)

[inline, virtual]

Implements dtDAL::NamedParameter.

template<class ParamType>

virtual const std::string dtDAL::NamedGenericParameter< ParamType >::ToString

(

)

const [inline, virtual]

Implements dtDAL::AbstractParameter.

Reimplemented in dtDAL::NamedPODParameter< ParamType >, dtDAL::NamedBooleanParameter, dtDAL::NamedStringParameter, dtDAL::NamedActorParameter, dtDAL::NamedGameEventParameter, dtDAL::NamedVecParameter< ParamType >, dtDAL::NamedPODParameter< long >, dtDAL::NamedPODParameter< unsigned long >, dtDAL::NamedPODParameter< double >, dtDAL::NamedPODParameter< float >, dtDAL::NamedPODParameter< int >, dtDAL::NamedPODParameter< unsigned int >, dtDAL::NamedPODParameter< short >, dtDAL::NamedPODParameter< unsigned short >, dtDAL::NamedPODParameter< unsigned char >, dtDAL::NamedPODParameter< bool >, dtDAL::NamedVecParameter< osg::Vec4 >, dtDAL::NamedVecParameter< osg::Vec2 >, dtDAL::NamedVecParameter< osg::Vec3 >, dtDAL::NamedVecParameter< osg::Vec3f >, dtDAL::NamedVecParameter< osg::Vec2f >, dtDAL::NamedVecParameter< osg::Vec3d >, dtDAL::NamedVecParameter< osg::Vec4f >, dtDAL::NamedVecParameter< osg::Vec2d >, and dtDAL::NamedVecParameter< osg::Vec4d >.

template<class ParamType>

virtual bool dtDAL::NamedGenericParameter< ParamType >::FromString

(

const std::string &

value

)

[inline, virtual]

Returns:

true if it was able to assign the value based on the string or false if not.

Parameters:

value

the string value to assign the parameter to.

Implements dtDAL::AbstractParameter.

Reimplemented in dtDAL::NamedPODParameter< ParamType >, dtDAL::NamedBooleanParameter, dtDAL::NamedStringParameter, dtDAL::NamedActorParameter, dtDAL::NamedGameEventParameter, dtDAL::NamedVec2Parameter, dtDAL::NamedVec2fParameter, dtDAL::NamedVec2dParameter, dtDAL::NamedVec3Parameter, dtDAL::NamedVec3fParameter, dtDAL::NamedVec3dParameter, dtDAL::NamedVec4Parameter, dtDAL::NamedVec4fParameter, dtDAL::NamedVec4dParameter, dtDAL::NamedPODParameter< long >, dtDAL::NamedPODParameter< unsigned long >, dtDAL::NamedPODParameter< double >, dtDAL::NamedPODParameter< float >, dtDAL::NamedPODParameter< int >, dtDAL::NamedPODParameter< unsigned int >, dtDAL::NamedPODParameter< short >, dtDAL::NamedPODParameter< unsigned short >, dtDAL::NamedPODParameter< unsigned char >, and dtDAL::NamedPODParameter< bool >.

template<class ParamType>

virtual bool dtDAL::NamedGenericParameter< ParamType >::operator==

(

const NamedParameter &

toCompare

)

const [inline, virtual]

Implements dtDAL::NamedParameter.

---