dtDAL::AbstractEnumActorProperty Class Reference

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

#include <enginepropertytypes.h>

Inheritance diagram for dtDAL::AbstractEnumActorProperty:

List of all members.

Public Member Functions
virtual DataType &	GetPropertyType () const =0
	Returns: the datatype for this enum actor property.
virtual dtUtil::Enumeration &	GetEnumValue () const =0
	Returns: the value as a generic enumeration
virtual void	SetEnumValue (dtUtil::Enumeration &value)=0
	Sets the value as a generic enumeration, but it must be the actual type stored in the implementation of this pure virtual class.
virtual const std::vector < dtUtil::Enumeration * > &	GetList () const =0
	Returns: A list of the possibilities for this enumeration property
virtual bool	SetValueFromString (const std::string &name)=0
	Sets the value of the property based on the string name of the enumeration, i.e.
virtual ActorProperty *	AsActorProperty ()
	This is a convenience method and enforces that only actor properties can implement this interface.
virtual const ActorProperty *	AsActorProperty () const
	This is a convenience method and enforces that only actor properties can implement this interface.
Protected Member Functions
virtual	~AbstractEnumActorProperty ()

---

Detailed Description

This actor property represents an abstract enumeration data member.

Note:

This abstract class exists so that all enumerations can be cast to this and worked with generically.

---

Constructor & Destructor Documentation

virtual dtDAL::AbstractEnumActorProperty::~AbstractEnumActorProperty

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual DataType& dtDAL::AbstractEnumActorProperty::GetPropertyType

(

)

const [pure virtual]

Returns:

the datatype for this enum actor property.

Implemented in dtDAL::EnumActorProperty< T >.

virtual dtUtil::Enumeration& dtDAL::AbstractEnumActorProperty::GetEnumValue

(

)

const [pure virtual]

Returns:

the value as a generic enumeration

Implemented in dtDAL::EnumActorProperty< T >.

virtual void dtDAL::AbstractEnumActorProperty::SetEnumValue

(

dtUtil::Enumeration &

value

)

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

Implemented in dtDAL::EnumActorProperty< T >.

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

(

)

const [pure virtual]

Returns:

A list of the possibilities for this enumeration property

Implemented in dtDAL::EnumActorProperty< T >.

virtual bool dtDAL::AbstractEnumActorProperty::SetValueFromString

(

const std::string &

name

)

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

Implemented in dtDAL::EnumActorProperty< T >.

virtual ActorProperty* dtDAL::AbstractEnumActorProperty::AsActorProperty

(

)

[inline, virtual]

This is a convenience method and enforces that only actor properties can implement this interface.

Returns:

the property as an actor property.

virtual const ActorProperty* dtDAL::AbstractEnumActorProperty::AsActorProperty

(

)

const [inline, virtual]

This is a convenience method and enforces that only actor properties can implement this interface.

Returns:

the property as an actor property.

---