iLab Neuromorphic Robotics Toolkit  0.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
nrt::StateDefinition< FieldGroups > Class Template Reference

#include <nrt/Probabilistic/Types/StateDefinition.H>

template<class... FieldGroups>
class nrt::StateDefinition< FieldGroups >

A State Definition is a collection of State Field Groups used in a probability distribution.

Template Parameters
FieldGroupsA variadic list of NRT_STATE_FIELD_GROUPs that will be included in the State Definition
// Create a State Fields group called Velocity2D that is composed of two elements: vx, and vy
NRT_STATE_FIELD_GROUP(Position2D,(x)(y));
// Create a State Fields group called Position2D that is composed of two elements: x, and y
NRT_STATE_FIELD_GROUP(Velocity2D,(x)(y));
// Create a new State Definition called "VehicleState" that can be used to keep track of
// 2D positions and velocities
typedef StateDefinition<Position2D, Velocity2D> VehicleState;
Examples:
tests/test-GaussianPDF.C, and tests/test-UKF.C.

Definition at line 91 of file StateDefinition.H.

Inherits nrt::StateDefinitionBase.

Public Types

typedef nrt::ConcatenateFields
< FieldGroups...>::fields 
fields
 A boost::mpl::vector containing a concatenation of all fields.
 
typedef
nrt::ConcatenateFieldGroups
< FieldGroups...>::groups 
groups
 A boost::mpl::vector containing a concatenation of all groups.
 

Static Public Member Functions

template<class Field >
static constexpr bool contains_field ()
 Does this State Definition contain the given field?
 
template<class Group >
static constexpr bool contains_field_group ()
 Does this State Definition contain the given field group?
 

Static Public Attributes

static size_t const num_fields =boost::mpl::size<fields>::value
 The total number of fields in this State Definition.
 

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