Factory for instantiating PropertyXAction instances. More...

#include <AircraftAction.h>

Inheritance diagram for Aircraft::PropertyXActFactory:

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

Protected Member Functions
BFSM::Action *	instance () const
	Create an instance of this class's action. More...

virtual bool	setFromXML (BFSM::Action action, TiXmlElement node, const std::string &behaveFldr) const
	Given a pointer to an Action instance, sets the appropriate fields from the provided XML node. More...

Detailed Description

Factory for instantiating PropertyXAction instances.

Member Function Documentation

virtual const char* Aircraft::PropertyXActFactory::description ( ) const

inlinevirtual

A description of the action.

Each action factory must override this function.

Returns: A string containing the action description.

BFSM::Action* Aircraft::PropertyXActFactory::instance ( ) const

inlineprotected

Create an instance of this class's action.

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

Returns: A pointer to a newly instantiated Action class.

virtual const char* Aircraft::PropertyXActFactory::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.

bool Aircraft::PropertyXActFactory::setFromXML	(	BFSM::Action *	action,
		TiXmlElement *	node,
		const std::string &	behaveFldr
	)		const

protectedvirtual

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

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

Parameters

action	A pointer to the action whose attributes are to be set.
node	The XML node containing the action attributes.
behaveFldr	The path to the behavior file. If the action 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/Plugins/aircraft/AircraftAction.h
src/Plugins/aircraft/AircraftAction.cpp

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation