dtDAL::NamedParameter

dtDAL::NamedParameter Class Reference

#include <namedparameter.h>

Inheritance diagram for dtDAL::NamedParameter:

dtDAL::AbstractParameter dtDAL::NamedGenericParameter< ParamType > dtDAL::NamedGenericParameter< bool > dtDAL::NamedGenericParameter< double > dtDAL::NamedGenericParameter< dtCore::UniqueId > dtDAL::NamedGenericParameter< float > dtDAL::NamedGenericParameter< int > dtDAL::NamedGenericParameter< long > dtDAL::NamedGenericParameter< osg::Vec2 > dtDAL::NamedGenericParameter< osg::Vec2d > dtDAL::NamedGenericParameter< osg::Vec2f > dtDAL::NamedGenericParameter< osg::Vec3 > dtDAL::NamedGenericParameter< osg::Vec3d > dtDAL::NamedGenericParameter< osg::Vec3f > dtDAL::NamedGenericParameter< osg::Vec4 > dtDAL::NamedGenericParameter< osg::Vec4d > dtDAL::NamedGenericParameter< osg::Vec4f > dtDAL::NamedGenericParameter< short > dtDAL::NamedGenericParameter< std::string > dtDAL::NamedGenericParameter< unsigned char > dtDAL::NamedGenericParameter< unsigned int > dtDAL::NamedGenericParameter< unsigned long > dtDAL::NamedGenericParameter< unsigned short > dtDAL::NamedGroupParameter dtDAL::NamedResourceParameter

List of all members.

Public Member Functions

 NamedParameter (const std::string &name, bool isList=false)
const std::string & GetName () const
 
Returns:
the name of this message parameter

virtual void ToDataStream (dtUtil::DataStream &stream) const =0
virtual void FromDataStream (dtUtil::DataStream &stream)=0
virtual void CopyFrom (const NamedParameter &otherParam)=0
 
Parameters:
otherParam the message parameter to make this one match.

void WriteToLog (dtUtil::Log &logger, dtUtil::Log::LogMessageType level=dtUtil::Log::LOG_DEBUG) const
 Writes pertinent data about this parameter to the given logger and log level.
bool IsList () const
 
Returns:
True if the paramater contains a list of data, false if this parameter only stores one value.

char GetParamDelimeter () const
 Gets the character used as a delimeter between parameters when serializing a message parameter containing a list of values to a string.
void SetParamDelimeter (char delim)
 Allows one to override the default delimeter used to serialize message parmeters to a string.
virtual void SetFromProperty (const dtDAL::ActorProperty &property)
 Sets the message parameter's value from the actor property's value.
virtual void ApplyValueToProperty (dtDAL::ActorProperty &property) const
 Sets the actor property's value from the message parameter's value.
virtual bool operator== (const NamedParameter &toCompare) const =0
bool operator!= (const NamedParameter &toCompare) const

Static Public Member Functions

static dtCore::RefPtr
< NamedParameter > 		CreateFromType (const dtDAL::DataType &type, const std::string &name, bool isList=false)
 Creates a message parameter that will hold the given type.

Static Public Attributes

static const char DEFAULT_DELIMETER = '|'

Protected Member Functions

virtual ~NamedParameter ()
void ValidatePropertyType (const dtDAL::ActorProperty &property) const
 Helper method for each specific parameter type to be able to validate the property type before acting on it.

Constructor & Destructor Documentation

dtDAL::NamedParameter::NamedParameter ( const std::string &  name,
bool  isList = false 
) [inline]

virtual dtDAL::NamedParameter::~NamedParameter (  )  [inline, protected, virtual]

Member Function Documentation

const std::string& dtDAL::NamedParameter::GetName (  )  const [inline, virtual]

Returns:
the name of this message parameter

Implements dtDAL::AbstractParameter.

virtual void dtDAL::NamedParameter::ToDataStream ( dtUtil::DataStream &  stream  )  const [pure virtual]

Implemented in dtDAL::NamedGroupParameter, dtDAL::NamedGenericParameter< 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 >, and dtDAL::NamedGenericParameter< osg::Vec4d >.

virtual void dtDAL::NamedParameter::FromDataStream ( dtUtil::DataStream &  stream  )  [pure virtual]

Implemented in dtDAL::NamedGroupParameter, dtDAL::NamedGenericParameter< 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 >, and dtDAL::NamedGenericParameter< osg::Vec4d >.

virtual void dtDAL::NamedParameter::CopyFrom ( const NamedParameter &  otherParam  )  [pure virtual]

Parameters:
otherParam the message parameter to make this one match.

Implemented in dtDAL::NamedGroupParameter, dtDAL::NamedGenericParameter< 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 >, and dtDAL::NamedGenericParameter< osg::Vec4d >.

void dtDAL::NamedParameter::WriteToLog ( dtUtil::Log &  logger,
dtUtil::Log::LogMessageType  level = dtUtil::Log::LOG_DEBUG 
) const

Writes pertinent data about this parameter to the given logger and log level.

bool dtDAL::NamedParameter::IsList (  )  const [inline]

Returns:
True if the paramater contains a list of data, false if this parameter only stores one value.

dtCore::RefPtr< NamedParameter > dtDAL::NamedParameter::CreateFromType ( const dtDAL::DataType &  type,
const std::string &  name,
bool  isList = false 
) [static]

Creates a message parameter that will hold the given type.

Parameters:
type the datatype the parameter should hold.
name the name of the parameter to create.
Exceptions:
dtUtil::Exception with dtGame::ExceptionEnum::INVALID_PARAMETER if the type is unsupported.

char dtDAL::NamedParameter::GetParamDelimeter (  )  const [inline]

Gets the character used as a delimeter between parameters when serializing a message parameter containing a list of values to a string.

Returns:
The delimeter. By default, this is equal to "|".

void dtDAL::NamedParameter::SetParamDelimeter ( char  delim  )  [inline]

Allows one to override the default delimeter used to serialize message parmeters to a string.

Parameters:
delim The new delimeter. This should NOT be the space character! Default value for the delimeter is the pipe character. '|'
See also:
GetParamDelimeter

void dtDAL::NamedParameter::SetFromProperty ( const dtDAL::ActorProperty &  property  )  [virtual]

Sets the message parameter's value from the actor property's value.

Reimplemented in dtDAL::NamedGroupParameter, dtDAL::NamedBooleanParameter, dtDAL::NamedIntParameter, dtDAL::NamedLongIntParameter, dtDAL::NamedFloatParameter, dtDAL::NamedDoubleParameter, dtDAL::NamedStringParameter, dtDAL::NamedEnumParameter, dtDAL::NamedActorParameter, dtDAL::NamedGameEventParameter, dtDAL::NamedVec2Parameter, dtDAL::NamedVec2fParameter, dtDAL::NamedVec2dParameter, dtDAL::NamedVec3Parameter, dtDAL::NamedVec3fParameter, dtDAL::NamedVec3dParameter, dtDAL::NamedVec4Parameter, dtDAL::NamedVec4fParameter, dtDAL::NamedVec4dParameter, and dtDAL::NamedResourceParameter.

void dtDAL::NamedParameter::ApplyValueToProperty ( dtDAL::ActorProperty &  property  )  const [virtual]

Sets the actor property's value from the message parameter's value.

Reimplemented in dtDAL::NamedGroupParameter, dtDAL::NamedBooleanParameter, dtDAL::NamedIntParameter, dtDAL::NamedLongIntParameter, dtDAL::NamedFloatParameter, dtDAL::NamedDoubleParameter, dtDAL::NamedStringParameter, dtDAL::NamedEnumParameter, dtDAL::NamedActorParameter, dtDAL::NamedGameEventParameter, dtDAL::NamedVec2Parameter, dtDAL::NamedVec2fParameter, dtDAL::NamedVec2dParameter, dtDAL::NamedVec3Parameter, dtDAL::NamedVec3fParameter, dtDAL::NamedVec3dParameter, dtDAL::NamedVec4Parameter, dtDAL::NamedVec4fParameter, dtDAL::NamedVec4dParameter, and dtDAL::NamedResourceParameter.

virtual bool dtDAL::NamedParameter::operator== ( const NamedParameter &  toCompare  )  const [pure virtual]

Implemented in dtDAL::NamedGroupParameter, dtDAL::NamedGenericParameter< 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 >, and dtDAL::NamedGenericParameter< osg::Vec4d >.

bool dtDAL::NamedParameter::operator!= ( const NamedParameter &  toCompare  )  const [inline]

void dtDAL::NamedParameter::ValidatePropertyType ( const dtDAL::ActorProperty &  property  )  const [protected]

Helper method for each specific parameter type to be able to validate the property type before acting on it.

Member Data Documentation

const char dtDAL::NamedParameter::DEFAULT_DELIMETER = '|' [static]

http://www.delta3d.org
2.0.0 generated 14 Feb 2008