Menge
Modular Pedestrian Simulation Framework for Research and Development
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Menge::BFSM::ConstDirVCFactory Class Reference

Factory for the ConstVelDirComponent. More...

#include <VelCompConst.h>

Inheritance diagram for Menge::BFSM::ConstDirVCFactory:
Menge::BFSM::VelCompFactory Menge::ElementFactory< VelComponent >

Public Member Functions

 ConstDirVCFactory ()
 Constructor.
 
virtual const char * name () const
 The name of the velocity component. More...
 
virtual const char * description () const
 A description of the velocity component. More...
 
- Public Member Functions inherited from Menge::ElementFactory< VelComponent >
 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...
 
VelComponent * createInstance (TiXmlElement *node, const std::string &behaveFldr) const
 Parses the xml data. More...
 

Protected Member Functions

VelComponentinstance () const
 Create an instance of this class's velocity component. More...
 
virtual bool setFromXML (VelComponent *vc, TiXmlElement *node, const std::string &behaveFldr) const
 Given a pointer to an VelComponent instance, sets the appropriate fields from the provided XML node. More...
 
- Protected Member Functions inherited from Menge::ElementFactory< VelComponent >
virtual ~ElementFactory ()
 Destructor.
 
virtual bool setFromXML (VelComponent *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...
 

Protected Attributes

size_t _xID
 The identifier for the "x" float attribute.
 
size_t _yID
 The identifier for the "y" float attribute.
 
- Protected Attributes inherited from Menge::ElementFactory< VelComponent >
AttributeSet _attrSet
 The attribute set for this factory.
 

Detailed Description

Factory for the ConstVelDirComponent.

Member Function Documentation

virtual const char* Menge::BFSM::ConstDirVCFactory::description ( ) const
inlinevirtual

A description of the velocity component.

Each velocity component factory must override this function.

Returns
A string containing the velocity component description.

Implements Menge::ElementFactory< VelComponent >.

VelComponent* Menge::BFSM::ConstDirVCFactory::instance ( ) const
inlineprotectedvirtual

Create an instance of this class's velocity component.

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

Returns
A pointer to a newly instantiated VelComponent class.

Implements Menge::ElementFactory< VelComponent >.

virtual const char* Menge::BFSM::ConstDirVCFactory::name ( ) const
inlinevirtual

The name of the velocity component.

The velocity component's name must be unique among all registered velocity components. Each velocity component factory must override this function.

Returns
A string containing the unique velocity component name.

Implements Menge::ElementFactory< VelComponent >.

bool Menge::BFSM::ConstDirVCFactory::setFromXML ( VelComponent vc,
TiXmlElement *  node,
const std::string &  behaveFldr 
) const
protectedvirtual

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

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

Parameters
vcA pointer to the velocity component whose attributes are to be set.
nodeThe XML node containing the velocity component attributes.
behaveFldrThe path to the behavior file. If the velocity component 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: