iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Model components, parameters, manager, and associated classes

These classes define how a complex model with parameters can be built from components.

Classes

class  nrt::Component
 A component of a model hierarchy. More...
 
class  nrt::Manager
 Manager of an entire model of Components. More...
 
class  nrt::ParameterRegistry
 A simple registry of all parameters associated with a component. More...
 

Modules

 Component Factory related classes and definitions
 
 Component parameter-related classes and functions
 

Functions

 nrt::NRT_DEFINE_ENUM_CLASS (RunStateAction,(PreInit)(Init)(PostInit)(PreStart)(Start)(PostStart)(InitiateLaunch)(CompleteLaunch)(InitiateEndrun)(CompleteEndrun)(PreStop)(Stop)(PostStop)(PreUninit)(Uninit)(PostUninit))
 Helper enum to set the run state of a Component that is possibly on a remote Blackboard. More...
 

Function Documentation

nrt::NRT_DEFINE_ENUM_CLASS ( RunStateAction  ,
(PreInit)(Init)(PostInit)(PreStart)(Start)(PostStart)(InitiateLaunch)(CompleteLaunch)(InitiateEndrun)(CompleteEndrun)(PreStop)(Stop)(PostStop)(PreUninit)(Uninit)(PostUninit)   
)

Helper enum to set the run state of a Component that is possibly on a remote Blackboard.

Note that normal users would typically rely on the started(), running(), etc member functions of Component as those describe the current state. The RunStateAction enum describes state transitions, at a finer granularity than is typically useful to normal users/programers. Mostly, this is used by the Blackboard system to bring the run state up and down step-by-step over the whole Blackboard federation.