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 | Friends | List of all members
Menge::Agents::ListObstacleSet Class Reference

Definition of obstacle set class which produces obstacles based on explicit definition in an XML file. More...

#include <ListObstacleSet.h>

Inheritance diagram for Menge::Agents::ListObstacleSet:
Menge::Agents::ObstacleSet Menge::Element Menge::Agents::ExplicitObstacleSet Menge::Agents::NavMeshObstacleSet

Public Member Functions

 ListObstacleSet ()
 Constructor.
 
virtual size_t obstacleCount ()
 Reports the number of obstacles in the set. More...
 
virtual ObstaclegetObstacle (size_t i)
 Get the ith obstacle. More...
 
bool addObstacle (Obstacle *o)
 Adds an obstacle to the generator. More...
 
bool addObstacle (ObstacleVertexList o)
 Adds an obstacle to the generator from a list of vertices. More...
 
- Public Member Functions inherited from Menge::Agents::ObstacleSet
 ObstacleSet ()
 Default constructor.
 
virtual void setClass (size_t cl)
 Sets the class of this obstacle set. More...
 
virtual size_t getClass ()
 Gets the class of this obstacle set. More...
 
- Public Member Functions inherited from Menge::Element
void destroy ()
 This supplants the destructor. More...
 
virtual BFSM::TaskgetTask ()
 Return an optional task associated with this element. More...
 
virtual SceneGraph::GLNodegetSGNode ()
 Returns an optional visualization element associated with the element. More...
 

Protected Member Functions

 ~ListObstacleSet ()
 Destructor.
 
- Protected Member Functions inherited from Menge::Agents::ObstacleSet
virtual ~ObstacleSet ()
 Protected destructor. The destroy method should be used to delete an instance of an obstacle set.
 

Protected Attributes

std::vector< Obstacle * > _obstacles
 The obstacles in an internal list.
 
- Protected Attributes inherited from Menge::Agents::ObstacleSet
size_t _class
 The class for the obstacles in this set. More...
 

Friends

class ExplicitObstacleSetFactory
 

Detailed Description

Definition of obstacle set class which produces obstacles based on explicit definition in an XML file.

Member Function Documentation

bool Menge::Agents::ListObstacleSet::addObstacle ( Obstacle o)

Adds an obstacle to the generator.

Parameters
oThe Obstacle Object to be added
Returns
true if the obstacle was added successfully
Exceptions
ObstacleSetExceptionif the obstacle is malformed
bool Menge::Agents::ListObstacleSet::addObstacle ( ObstacleVertexList  o)

Adds an obstacle to the generator from a list of vertices.

Parameters
oObstacleVertexList struct representing the incoming obstacle
Returns
true if the obstacle was added successfully
Exceptions
ObstacleSetExceptionif the obstacle is malformed
Obstacle * Menge::Agents::ListObstacleSet::getObstacle ( size_t  i)
virtual

Get the ith obstacle.

Parameters
iThe index of the requested obstacle.
Returns
The Obstacle object
Exceptions
ObstacleSetExceptionif the index, i, is invalid.

Implements Menge::Agents::ObstacleSet.

virtual size_t Menge::Agents::ListObstacleSet::obstacleCount ( )
inlinevirtual

Reports the number of obstacles in the set.

Returns
The number of obstacles in this set

Implements Menge::Agents::ObstacleSet.


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