dtDAL::NamedStringParameter Class Reference

#include <namedparameter.h>

Inheritance diagram for dtDAL::NamedStringParameter:

List of all members.

Public Member Functions
	NamedStringParameter (const std::string &name, const std::string &defaultValue="", bool isList=false)
virtual const dtDAL::DataType &	GetDataType () const
	Returns:
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 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.
Protected Member Functions
virtual	~NamedStringParameter ()

---

Constructor & Destructor Documentation

dtDAL::NamedStringParameter::NamedStringParameter	(	const std::string &	name,
		const std::string &	defaultValue = "",
		bool	isList = false
	)

dtDAL::NamedStringParameter::~NamedStringParameter

(

)

[protected, virtual]

---

Member Function Documentation

virtual const dtDAL::DataType& dtDAL::NamedStringParameter::GetDataType

(

)

const [inline, virtual]

Returns:

Implements dtDAL::AbstractParameter.

Reimplemented in dtDAL::NamedEnumParameter.

const std::string dtDAL::NamedStringParameter::ToString

(

)

const [virtual]

Reimplemented from dtDAL::NamedGenericParameter< std::string >.

bool dtDAL::NamedStringParameter::FromString

(

const std::string &

value

)

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

Reimplemented from dtDAL::NamedGenericParameter< std::string >.

void dtDAL::NamedStringParameter::SetFromProperty

(

const dtDAL::ActorProperty &

property

)

[virtual]

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

Reimplemented from dtDAL::NamedParameter.

Reimplemented in dtDAL::NamedEnumParameter.

void dtDAL::NamedStringParameter::ApplyValueToProperty

(

dtDAL::ActorProperty &

property

)

const [virtual]

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

Reimplemented from dtDAL::NamedParameter.

Reimplemented in dtDAL::NamedEnumParameter.

---