Menge::BFSM::ProbTargetFactory Class Reference

The factory for creating the ProbTarget. More...

#include <TargetProb.h>

Inheritance diagram for Menge::BFSM::ProbTargetFactory:

Public Member Functions
virtual const char *	name () const
	The name of the action. More...
virtual const char *	description () const
	A description of the action. More...
Public Member Functions inherited from Menge::ElementFactory< TransitionTarget >
	ElementFactory ()
	Default constructor.
void	destroy ()
	This supplants the destructor. More...
bool	thisFactory (const std::string &typeName) const
	Reports if the xml node defines an element for this factory. More...
TransitionTarget *	createInstance (TiXmlElement *node, const std::string &behaveFldr) const
	Parses the xml data. More...

Protected Member Functions
virtual TransitionTarget *	instance () const
	Create an instance of this class's condition. More...
virtual bool	setFromXML (TransitionTarget *target, TiXmlElement *node, const std::string &behaveFldr) const
	Given a pointer to an Condition instance, sets the appropriate fields from the provided XML node. More...
Protected Member Functions inherited from Menge::ElementFactory< TransitionTarget >
virtual	~ElementFactory ()
	Destructor.
virtual bool	setFromXML (TransitionTarget *element, TiXmlElement *node, const std::string &specFldr) const
	Given a pointer to an element instance, sets the appropriate fields from the provided XML node. More...

Additional Inherited Members
Protected Attributes inherited from Menge::ElementFactory< TransitionTarget >
AttributeSet	_attrSet
	The attribute set for this factory.

Detailed Description

The factory for creating the ProbTarget.

Member Function Documentation

virtual const char* Menge::BFSM::ProbTargetFactory::description ( ) const

inlinevirtual

A description of the action.

Each action factory must override this function.

Returns

A string containing the action description.

Implements Menge::ElementFactory< TransitionTarget >.

virtual TransitionTarget* Menge::BFSM::ProbTargetFactory::instance ( ) const

inlineprotectedvirtual

Create an instance of this class's condition.

All ConditionFactory sub-classes must override this by creating (on the heap) a new instance of its corresponding condition type. The various field values of the instance will be set in a subsequent call to ConditionFactory::setFromXML. The caller of this function takes ownership of the memory.

Returns

A pointer to a newly instantiated TransitionTarget class.

Implements Menge::ElementFactory< TransitionTarget >.

virtual const char* Menge::BFSM::ProbTargetFactory::name ( ) const

inlinevirtual

The name of the action.

The action's name must be unique among all registered actions. Each action factory must override this function.

Returns

A string containing the unique action name.

Implements Menge::ElementFactory< TransitionTarget >.

bool Menge::BFSM::ProbTargetFactory::setFromXML ( TransitionTarget *  target, TiXmlElement *  node, const std::string &  behaveFldr  ) const

protectedvirtual

Given a pointer to an Condition instance, sets the appropriate fields from the provided XML node.

It is assumed that the value of the type attribute is this Tarnsitions's type. (i.e. ConditionFactory::thisFactory has already been called and returned true.) If sub-classes of ConditionFactory introduce new Condition parameters, then the sub-class should override this method but explicitly call the parent class's version.

Parameters

target	A pointer to the transition target whose attributes are to be set.
node	The XML node containing the condition attributes.
behaveFldr	The path to the behavior file. If the condition references resources in the file system, it should be defined relative to the behavior file location. This is the folder containing that path.

Returns

A boolean reporting success (true) or failure (false).

---

The documentation for this class was generated from the following files:

• src/menge/MengeCore/BFSM/Transitions/TargetProb.h
• src/menge/MengeCore/BFSM/Transitions/TargetProb.cpp