ompl::base::CompoundState Class Reference

Definition of a compound state. More...

#include <ompl/base/State.h>

Inheritance diagram for ompl::base::CompoundState:

Public Member Functions
template<class T>
const T *	as (unsigned int index) const
	Cast a component of this instance to a desired type.
template<class T>
T *	as (const unsigned int index)
	Cast a component of this instance to a desired type.
const State *	operator[] (unsigned int i) const
	Access const element ith component. This does not check whether the index is within bounds.
State *	operator[] (unsigned int i)
	Access element ith component. This does not check whether the index is within bounds.
Public Member Functions inherited from ompl::base::State
template<class T>
const T *	as () const
	Cast this instance to a desired type.
template<class T>
T *	as ()
	Cast this instance to a desired type.

Public Attributes
State **	components {nullptr}
	The components that make up a compound state.

Detailed Description

Definition of a compound state.

Definition at line 86 of file State.h.

Member Function Documentation

as() [1/2]

template<class T>

T * ompl::base::CompoundState::as ( const unsigned int index )

inline

Cast a component of this instance to a desired type.

Make sure the type we are allocating is indeed a state

Definition at line 105 of file State.h.

as() [2/2]

template<class T>

const T * ompl::base::CompoundState::as ( unsigned int index ) const

inline

Cast a component of this instance to a desired type.

Make sure the type we are allocating is indeed a state

Definition at line 95 of file State.h.

operator[]() [1/2]

State * ompl::base::CompoundState::operator[] ( unsigned int i )

inline

Access element i^th component. This does not check whether the index is within bounds.

Definition at line 122 of file State.h.

operator[]() [2/2]

const State * ompl::base::CompoundState::operator[] ( unsigned int i ) const

inline

Access const element i^th component. This does not check whether the index is within bounds.

Definition at line 115 of file State.h.

Member Data Documentation

components

State** ompl::base::CompoundState::components {nullptr}

The components that make up a compound state.

Definition at line 128 of file State.h.

---

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

• ompl/base/State.h