dtDAL::BooleanActorProperty Class Reference

This actor property represents a boolean data member. More...

#include <enginepropertytypes.h>

Inheritance diagram for dtDAL::BooleanActorProperty:

List of all members.

Public Member Functions
	BooleanActorProperty (const std::string &name, const std::string &label, Functor1< bool > set, Functor0Ret< bool > get, const std::string &desc="", const std::string &groupName="")
virtual bool	FromString (const std::string &value)
	Sets the value of the property based on a string.
virtual const std::string	ToString () const
	Returns: a string version of the data.
Protected Member Functions
virtual	~BooleanActorProperty ()

---

Detailed Description

This actor property represents a boolean data member.

---

Constructor & Destructor Documentation

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

virtual dtDAL::BooleanActorProperty::~BooleanActorProperty

(

)

[inline, protected, virtual]

---

Member Function Documentation

bool dtDAL::BooleanActorProperty::FromString

(

const std::string &

value

)

[virtual]

Sets the value of the property based on a string.

The string should be a boolean value (true or false) as a string.

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.

const std::string dtDAL::BooleanActorProperty::ToString

(

)

const [virtual]

Returns:

a string version of the data.

This value can be used when calling FromString.

See also:

FromString

Implements dtDAL::AbstractParameter.

---