makVrv::DtStateView< StateType > Class Template Reference

template<class StateType>
class makVrv::DtStateView< StateType >

A DtStateView is a the interface to simulation state information. Users can create DtStateViews for specific state they care about and it will be updated at the requested rate.

Inheritance diagram for makVrv::DtStateView< StateType >:

Public Member Functions
	DtStateView (DtSimEntry &entry)
virtual	~DtStateView ()
void	forceUpdate ()
void	setUpdateRate (DtSimEntryUpdater::UpdateRate rate)
virtual void	emitStateViewUpdated ()
const StateType &	state ()
const StateType &	state () const
DtUniqueID	id () const
Public Member Functions inherited from makVrv::DtBaseStateView
virtual	~DtBaseStateView ()

Static Public Member Functions
static bool	isCompatible (DtSimEntry &entry)
static bool	isCompatible (DtSimState &entry)
static StateType *	findState (DtSimEntry &entry)

Public Attributes
boost::signalslib::signal < void(DtStateView< StateType > *)>	signal_stateViewUpdated

Protected Attributes
DtSimEntry &	mySimEntry
StateType *	myState

Private Member Functions
	DtStateView ()
	DtStateView (const DtStateView &)
DtStateView &	operator= (const DtStateView &)

Additional Inherited Members
Protected Member Functions inherited from makVrv::DtBaseStateView
	DtBaseStateView ()

Constructor & Destructor Documentation

template<class StateType >

makVrv::DtStateView< StateType >::DtStateView

(

DtSimEntry &

entry

)

CTOR.

References makVrv::DtStateView< StateType >::findState(), and makVrv::DtStateView< StateType >::myState.

template<class StateType >

makVrv::DtStateView< StateType >::~DtStateView ( )

virtual

DTOR.

References makVrv::DtSimEntryUpdater::NoUpdates.

template<class StateType>

makVrv::DtStateView< StateType >::DtStateView ( )

private

Non-Existant.

template<class StateType>

makVrv::DtStateView< StateType >::DtStateView ( const DtStateView< StateType > &  )

private

Member Function Documentation

template<class StateType >

void makVrv::DtStateView< StateType >::forceUpdate

(

)

Force a single update which will be sent to all views regardless of update rates.

template<class StateType >

void makVrv::DtStateView< StateType >::setUpdateRate

(

DtSimEntryUpdater::UpdateRate

rate

)

Set the rate this view will be updated with state information.

Referenced by makVrv::DtStateViewCollection< T >::onSimObjectEntryAdded(), and makVrv::DtStateViewCollection< T >::onSimObjectStateEntryAdded().

template<class StateType >

void makVrv::DtStateView< StateType >::emitStateViewUpdated ( )

virtual

This will get called by the DtSimEntry when the state for this view has been updated. This emits a signal containing the state view that was updated.

Implements makVrv::DtBaseStateView.

template<class StateType >

const StateType & makVrv::DtStateView< StateType >::state

(

)

Return the state this is a view onto.

template<class StateType >

const StateType & makVrv::DtStateView< StateType >::state

(

)

const

Return the state this is a view onto.

template<class StateType >

bool makVrv::DtStateView< StateType >::isCompatible ( DtSimEntry &  entry )

static

Returns true if the DtSimEntry contains a state of type T.

References makVrv::DtStateView< StateType >::findState().

Referenced by makVrv::DtStateViewCollection< T >::isCompatible(), and makVrv::DtSimObjectEntryCollection< T >::isCompatible().

template<class StateType >

bool makVrv::DtStateView< StateType >::isCompatible ( DtSimState &  entry )

static

Returns true if the DtSimState is of of type T.

template<class StateType >

StateType * makVrv::DtStateView< StateType >::findState ( DtSimEntry &  entry )

static

Returns a pointer to the state type for an entry, if the state is not found a null pointer is returned.

References makVrv::DtSimEntry::simStates().

Referenced by makVrv::DtStateView< StateType >::DtStateView(), and makVrv::DtStateView< StateType >::isCompatible().

template<class StateType>

DtUniqueID makVrv::DtStateView< StateType >::id ( ) const

inline

template<class StateType>

DtStateView& makVrv::DtStateView< StateType >::operator= ( const DtStateView< StateType > &  )

private

Member Data Documentation

template<class StateType>

boost::signalslib::signal<void (DtStateView<StateType>*)> makVrv::DtStateView< StateType >::signal_stateViewUpdated

Emitted when a this view's state has been updated.

template<class StateType>

DtSimEntry& makVrv::DtStateView< StateType >::mySimEntry

protected

Referenced by makVrv::DtStateView< DtVrfObjectDataState >::id().

template<class StateType>

StateType* makVrv::DtStateView< StateType >::myState

protected

Referenced by makVrv::DtStateView< StateType >::DtStateView().

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrvCore/DtStateView.h