dtDAL::EnumActorProperty< T > Class Template Reference

This actor property represents an enumeration data member. More...

#include <enginepropertytypes.h>

Inheritance diagram for dtDAL::EnumActorProperty< T >:

List of all members.

Public Member Functions
	EnumActorProperty (const std::string &name, const std::string &label, Functor1< T & > set, Functor0Ret< T & > get, const std::string &desc="", const std::string &groupName="")
DataType &	GetPropertyType () const
	Note: this method exists to reconcile the two same-named methods on the superclases.
virtual const std::vector < dtUtil::Enumeration * > &	GetList () const
	Returns: A list of the possibilities for this enumeration property
virtual const std::vector< T * > &	GetListOfType () const
virtual bool	SetValueFromString (const std::string &name)
	Sets the value of the property based on the string name of the enumeration, i.e.
virtual dtUtil::Enumeration &	GetEnumValue () const
	Returns: the value as a generic enumeration
virtual void	SetEnumValue (dtUtil::Enumeration &value)
	Sets the value as a generic enumeration, but it must be the actual type stored in the implementation of this pure virtual class.
virtual bool	FromString (const std::string &value)
	the same as SetValueFromString
virtual const std::string	ToString () const
	Returns: a string version of the data.
Protected Member Functions
virtual	~EnumActorProperty ()

---

Detailed Description

template<typename T>
class dtDAL::EnumActorProperty< T >

This actor property represents an enumeration data member.

---

Constructor & Destructor Documentation

template<typename T>

dtDAL::EnumActorProperty< T >::EnumActorProperty	(	const std::string &	name,
		const std::string &	label,
		Functor1< T & >	set,
		Functor0Ret< T & >	get,
		const std::string &	desc = "",
		const std::string &	groupName = ""
	)			[inline]

template<typename T>

virtual dtDAL::EnumActorProperty< T >::~EnumActorProperty

(

)

[inline, protected, virtual]

---

Member Function Documentation

template<typename T>

DataType& dtDAL::EnumActorProperty< T >::GetPropertyType

(

)

const [inline, virtual]

Note:

this method exists to reconcile the two same-named methods on the superclases.

Implements dtDAL::AbstractEnumActorProperty.

template<typename T>

virtual const std::vector<dtUtil::Enumeration*>& dtDAL::EnumActorProperty< T >::GetList

(

)

const [inline, virtual]

Returns:

A list of the possibilities for this enumeration property

Implements dtDAL::AbstractEnumActorProperty.

template<typename T>

virtual const std::vector<T*>& dtDAL::EnumActorProperty< T >::GetListOfType

(

)

const [inline, virtual]

template<typename T>

virtual bool dtDAL::EnumActorProperty< T >::SetValueFromString

(

const std::string &

name

)

[inline, virtual]

Sets the value of the property based on the string name of the enumeration, i.e.

getName() on Enumeration. If it fails, the value will remain unchanged.

Parameters:

name

The name of the value.

Returns:

true if it was successful in matching an name to a value.

See also:

Enumeration::getName

Implements dtDAL::AbstractEnumActorProperty.

template<typename T>

virtual dtUtil::Enumeration& dtDAL::EnumActorProperty< T >::GetEnumValue

(

)

const [inline, virtual]

Returns:

the value as a generic enumeration

Implements dtDAL::AbstractEnumActorProperty.

template<typename T>

virtual void dtDAL::EnumActorProperty< T >::SetEnumValue

(

dtUtil::Enumeration &

value

)

[inline, virtual]

Sets the value as a generic enumeration, but it must be the actual type stored in the implementation of this pure virtual class.

Parameters:

value

Implements dtDAL::AbstractEnumActorProperty.

template<typename T>

virtual bool dtDAL::EnumActorProperty< T >::FromString

(

const std::string &

value

)

[inline, virtual]

the same as SetValueFromString

See also:

SetValueFromString

Note:

Returns false it the property is read only

Parameters:

value

the value to set.

Returns:

true if the value could be parsed.

Implements dtDAL::AbstractParameter.

template<typename T>

virtual const std::string dtDAL::EnumActorProperty< T >::ToString

(

)

const [inline, virtual]

Returns:

a string version of the data.

This value can be used when calling FromString.

See also:

FromString

Implements dtDAL::AbstractParameter.

---