PPL API Reference
Overview Core Algorithm Abstractions Utilities Parallel Methods
Modules Class Hierarchy Classes Functions
Todo List Bug List Dead Code
List of all members
StepFunction Class Referenceabstract

Public Member Functions

Interface
virtual void StepAgent (double _dt)=0
 Function to call the step function behavior. More...
 

Protected Attributes

Internal State
Agentm_agent
 
bool m_debug {false}
 

Construction

 StepFunction (Agent *_agent, XMLNode &_node)
 
 ~StepFunction ()
 
static std::unique_ptr< StepFunctionFactory (Agent *const _a, XMLNode &_node)
 

Detailed Description

This is a virtual base class for agent functions. Agent behavior will be customizeable by the step function behavior.

Member Function Documentation

◆ Factory()

std::unique_ptr< StepFunction > StepFunction::Factory ( Agent *const  _a,
XMLNode _node 
)
static

Create a dynamically-allocated agent from an XML node.

Parameters
_rThe robot which this agent will reason for.
_nodeThe XML node to parse.
Returns
An agent of the type specified by _node.

◆ StepAgent()

virtual void StepFunction::StepAgent ( double  _dt)
pure virtual

Function to call the step function behavior.

Implemented in DefaultCoordinatorStepFunction.


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