Menge
Modular Pedestrian Simulation Framework for Research and Development
|
Factory for the RoadMapVelComponent. More...
#include <VelCompRoadMap.h>
Public Member Functions | |
RoadMapVCFactory () | |
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 | |
VelComponent * | instance () 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 | _fileNameID |
The identifier for the "file_name" string attribute. | |
Protected Attributes inherited from Menge::ElementFactory< VelComponent > | |
AttributeSet | _attrSet |
The attribute set for this factory. | |
Factory for the RoadMapVelComponent.
|
inlinevirtual |
A description of the velocity component.
Each velocity component factory must override this function.
Implements Menge::ElementFactory< VelComponent >.
|
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.
Implements Menge::ElementFactory< VelComponent >.
|
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.
Implements Menge::ElementFactory< VelComponent >.
|
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.
vc | A pointer to the velocity component whose attributes are to be set. |
node | The XML node containing the velocity component attributes. |
behaveFldr | The 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. |