dtDAL::AbstractParameter Class Reference

a common base class for actor property and named parameter, especially helpful in the load/save process. More...

#include <abstractparameter.h>

Inheritance diagram for dtDAL::AbstractParameter:

List of all members.

Public Member Functions
virtual const std::string &	GetName () const =0
	Returns: the name of this message parameter
virtual const dtDAL::DataType &	GetDataType () const =0
	Returns:
virtual const std::string	ToString () const =0
virtual bool	FromString (const std::string &value)=0
	Returns: true if it was able to assign the value based on the string or false if not.
Protected Member Functions
virtual	~AbstractParameter ()

---

Detailed Description

a common base class for actor property and named parameter, especially helpful in the load/save process.

More is expected to be added to this over time as features are unified between the two sets of classes.

---

Constructor & Destructor Documentation

virtual dtDAL::AbstractParameter::~AbstractParameter

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual const std::string& dtDAL::AbstractParameter::GetName

(

)

const [pure virtual]

Returns:

the name of this message parameter

Implemented in dtDAL::ActorProperty, and dtDAL::NamedParameter.

virtual const dtDAL::DataType& dtDAL::AbstractParameter::GetDataType

(

)

const [pure virtual]

Returns:

Implemented in dtDAL::ActorProperty, dtDAL::NamedGroupParameter, dtDAL::NamedBooleanParameter, dtDAL::NamedUnsignedCharParameter, dtDAL::NamedShortIntParameter, dtDAL::NamedUnsignedShortIntParameter, dtDAL::NamedUnsignedIntParameter, dtDAL::NamedIntParameter, dtDAL::NamedUnsignedLongIntParameter, dtDAL::NamedLongIntParameter, dtDAL::NamedFloatParameter, dtDAL::NamedDoubleParameter, dtDAL::NamedStringParameter, dtDAL::NamedEnumParameter, dtDAL::NamedActorParameter, dtDAL::NamedGameEventParameter, dtDAL::NamedVec2Parameter, dtDAL::NamedVec2fParameter, dtDAL::NamedVec2dParameter, dtDAL::NamedVec3Parameter, dtDAL::NamedRGBColorParameter, dtDAL::NamedVec3fParameter, dtDAL::NamedVec3dParameter, dtDAL::NamedVec4Parameter, dtDAL::NamedRGBAColorParameter, dtDAL::NamedVec4fParameter, dtDAL::NamedVec4dParameter, and dtDAL::NamedResourceParameter.

virtual const std::string dtDAL::AbstractParameter::ToString

(

)

const [pure virtual]

Implemented in dtDAL::ActorActorProperty, dtDAL::GameEventActorProperty, dtDAL::ResourceActorProperty, dtDAL::FloatActorProperty, dtDAL::DoubleActorProperty, dtDAL::IntActorProperty, dtDAL::LongActorProperty, dtDAL::StringActorProperty, dtDAL::BooleanActorProperty, dtDAL::EnumActorProperty< T >, dtDAL::Vec2ActorProperty, dtDAL::Vec2fActorProperty, dtDAL::Vec2dActorProperty, dtDAL::Vec3ActorProperty, dtDAL::Vec3fActorProperty, dtDAL::Vec3dActorProperty, dtDAL::Vec4ActorProperty, dtDAL::Vec4fActorProperty, dtDAL::Vec4dActorProperty, dtDAL::ColorRgbaActorProperty, dtDAL::GroupActorProperty, dtDAL::NamedGroupParameter, dtDAL::NamedGenericParameter< ParamType >, dtDAL::NamedPODParameter< ParamType >, dtDAL::NamedBooleanParameter, dtDAL::NamedStringParameter, dtDAL::NamedActorParameter, dtDAL::NamedGameEventParameter, dtDAL::NamedVecParameter< ParamType >, dtDAL::NamedResourceParameter, dtDAL::NamedGenericParameter< long >, dtDAL::NamedGenericParameter< osg::Vec4 >, dtDAL::NamedGenericParameter< unsigned long >, dtDAL::NamedGenericParameter< double >, dtDAL::NamedGenericParameter< osg::Vec2 >, dtDAL::NamedGenericParameter< std::string >, dtDAL::NamedGenericParameter< osg::Vec3 >, dtDAL::NamedGenericParameter< float >, dtDAL::NamedGenericParameter< int >, dtDAL::NamedGenericParameter< unsigned int >, dtDAL::NamedGenericParameter< dtCore::UniqueId >, dtDAL::NamedGenericParameter< short >, dtDAL::NamedGenericParameter< unsigned short >, dtDAL::NamedGenericParameter< unsigned char >, dtDAL::NamedGenericParameter< osg::Vec3f >, dtDAL::NamedGenericParameter< bool >, dtDAL::NamedGenericParameter< osg::Vec2f >, dtDAL::NamedGenericParameter< osg::Vec3d >, dtDAL::NamedGenericParameter< osg::Vec4f >, dtDAL::NamedGenericParameter< osg::Vec2d >, dtDAL::NamedGenericParameter< osg::Vec4d >, 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 >.

virtual bool dtDAL::AbstractParameter::FromString

(

const std::string &

value

)

[pure 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.

Implemented in dtDAL::ActorActorProperty, dtDAL::GameEventActorProperty, dtDAL::ResourceActorProperty, dtDAL::FloatActorProperty, dtDAL::DoubleActorProperty, dtDAL::IntActorProperty, dtDAL::LongActorProperty, dtDAL::StringActorProperty, dtDAL::BooleanActorProperty, dtDAL::EnumActorProperty< T >, dtDAL::Vec2ActorProperty, dtDAL::Vec2fActorProperty, dtDAL::Vec2dActorProperty, dtDAL::Vec3ActorProperty, dtDAL::Vec3fActorProperty, dtDAL::Vec3dActorProperty, dtDAL::Vec4ActorProperty, dtDAL::Vec4fActorProperty, dtDAL::Vec4dActorProperty, dtDAL::ColorRgbaActorProperty, dtDAL::GroupActorProperty, dtDAL::NamedGroupParameter, dtDAL::NamedGenericParameter< ParamType >, 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::NamedResourceParameter, dtDAL::NamedGenericParameter< long >, dtDAL::NamedGenericParameter< osg::Vec4 >, dtDAL::NamedGenericParameter< unsigned long >, dtDAL::NamedGenericParameter< double >, dtDAL::NamedGenericParameter< osg::Vec2 >, dtDAL::NamedGenericParameter< std::string >, dtDAL::NamedGenericParameter< osg::Vec3 >, dtDAL::NamedGenericParameter< float >, dtDAL::NamedGenericParameter< int >, dtDAL::NamedGenericParameter< unsigned int >, dtDAL::NamedGenericParameter< dtCore::UniqueId >, dtDAL::NamedGenericParameter< short >, dtDAL::NamedGenericParameter< unsigned short >, dtDAL::NamedGenericParameter< unsigned char >, dtDAL::NamedGenericParameter< osg::Vec3f >, dtDAL::NamedGenericParameter< bool >, dtDAL::NamedGenericParameter< osg::Vec2f >, dtDAL::NamedGenericParameter< osg::Vec3d >, dtDAL::NamedGenericParameter< osg::Vec4f >, dtDAL::NamedGenericParameter< osg::Vec2d >, dtDAL::NamedGenericParameter< osg::Vec4d >, 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 >.

---