makVre::DtCigiObjectBase Class Reference

#include <cigiObjectBase.h>

Inheritance diagram for makVre::DtCigiObjectBase:

Public Types
using	Cigi = CigiBasePacket
using	CigiData = DtCigiDataTemplate<CigiBasePacket, DtCigiObjectBase>
using	CigiBasePtr = std::shared_ptr<DtCigiDataBase>
Public Types inherited from makVre::DtSpSubClass< DtCigiObjectBase >
using	Super
using	Ptr
using	Sptr
using	Wptr
Public Types inherited from makVre::DtSpObject
using	Ptr = DtSpObject*
using	Sptr = std::shared_ptr<DtSpObject>
using	Wptr = std::weak_ptr<DtSpObject>

Public Member Functions
	DtCigiObjectBase ()
virtual	~DtCigiObjectBase () override
CigiData *	cigi ()
CigiData *const	cigi () const
virtual Cigi_uint16	cigiType ()
virtual Sptr	setSession (DtCigiSession &session)
virtual DtCigiSession &	session () const
virtual bool	init ()
virtual unsigned int	sessionVersion () const
virtual void	markDirty ()
virtual void	markClean ()
virtual bool	isDirty () const
Public Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
	DtSpSubClass ()
virtual	~DtSpSubClass ()
Sptr	self ()
std::string	type () const override
Public Member Functions inherited from makVre::DtSpObject
	DtSpObject ()
virtual	~DtSpObject ()
Sptr	self ()
virtual void	setName (const std::string &name)
virtual std::string	name () const

Protected Member Functions
virtual DtCigiDataBase *	createCigi ()=0
DtCigiDataBase *	cigiBase ()
DtCigiDataBase *const	cigiBase () const
template<typename VALUE_T>
bool	updateValue (VALUE_T *value, VALUE_T source)

Protected Attributes
CigiBasePtr	myCigiData
DtCigiSession *	mySession
bool	myDirty
Protected Attributes inherited from makVre::DtSpObject
std::string	myName

Additional Inherited Members
Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
static std::string	Type ()
static std::shared_ptr< DtCigiObjectBase >	create ()
static void	registerCreator ()
static std::shared_ptr< DtCigiObjectBase >	createVersion (unsigned int version)
static void	registerCreatorVersion (unsigned int version)
Static Public Member Functions inherited from makVre::DtSpObject
template<class AS_T>
static std::shared_ptr< AS_T >	cast (Sptr p)
template<class AS_T>
static std::shared_ptr< AS_T >	unsafe_cast (Sptr p)
Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
static std::shared_ptr< DtBaseCreator< DtCigiObjectBase > > &	creator ()
static std::shared_ptr< DtBaseCreator< DtCigiObjectBase > > &	creatorVersion (unsigned int version)

Member Typedef Documentation

Cigi

using makVre::DtCigiObjectBase::Cigi = CigiBasePacket

CigiData

using makVre::DtCigiObjectBase::CigiData = DtCigiDataTemplate<CigiBasePacket, DtCigiObjectBase>

CigiBasePtr

using makVre::DtCigiObjectBase::CigiBasePtr = std::shared_ptr<DtCigiDataBase>

Constructor & Destructor Documentation

DtCigiObjectBase()

makVre::DtCigiObjectBase::DtCigiObjectBase

(

)

~DtCigiObjectBase()

virtual makVre::DtCigiObjectBase::~DtCigiObjectBase ( )

overridevirtual

Member Function Documentation

cigi() [1/2]

CigiData * makVre::DtCigiObjectBase::cigi

(

)

Get pointer to CIGI packet data managed by this object.

cigi() [2/2]

CigiData *const makVre::DtCigiObjectBase::cigi

(

)

const

cigiType()

virtual Cigi_uint16 makVre::DtCigiObjectBase::cigiType ( )

virtual

Get the ID of the CigiData type.

Returns

cigi()->GetPacketID()

setSession()

virtual Sptr makVre::DtCigiObjectBase::setSession ( DtCigiSession & session )

virtual

Get/Set reference to the CigiSession to which this object belongs.

References session().

session()

virtual DtCigiSession & makVre::DtCigiObjectBase::session ( ) const

virtual

Referenced by makVre::DtCigiTimePublisher::addToSession(), and setSession().

init()

virtual bool makVre::DtCigiObjectBase::init ( )

virtual

Reimplemented in makVre::DtCigiEntityPublisherBase, makVre::DtCigiEntityUnpublisher, makVre::DtCigiIgControlPublisher, makVre::DtCigiListenerBase, makVre::DtCigiPublisherBase, makVre::DtCigiPublisherGroup, makVre::DtCigiSimObjectPublisherBase, makVre::DtCigiTimePublisher, makVre::DtCigiViewControlPublisher, and makVre::DtCigiViewDefinitionPublisher.

sessionVersion()

virtual unsigned int makVre::DtCigiObjectBase::sessionVersion ( ) const

virtual

Get CIGI protocol major version number for this Session.

Referenced by makVre::DtCigiPublisherBase::addNewChild().

markDirty()

virtual void makVre::DtCigiObjectBase::markDirty ( )

virtual

Dirty flag indicates whether this CIGI data has changed in this frame.

Used by Publishers to determine when to write and send data to the IG.

Referenced by updateValue().

markClean()

virtual void makVre::DtCigiObjectBase::markClean ( )

virtual

isDirty()

virtual bool makVre::DtCigiObjectBase::isDirty ( ) const

virtual

Reimplemented in makVre::DtCigiEntityUnpublisher, and makVre::DtCigiIgControlPublisher.

createCigi()

virtual DtCigiDataBase * makVre::DtCigiObjectBase::createCigi ( )

protectedpure virtual

Implemented in makVre::DtCigiListenerTemplate< CIGI_T, SELF_T, SUPER_T, DATA_CREATOR_T >, makVre::DtCigiListenerTemplate< CigiBaseSOF, DtCigiStartOfFrameListener >, makVre::DtCigiListenerTemplate< CigiSOFV4, DtCigiStartOfFrameListenerV4, DtCigiStartOfFrameListener, DtCigiDataCreator >, makVre::DtCigiPublisherGroup, makVre::DtCigiPublisherTemplate< CIGI_T, SELF_T, SUPER_T, DATA_CREATOR_T >, makVre::DtCigiPublisherTemplate< CigiArtPartCtrlV4, DtCigiSimEntityArtPartPublisherV4, DtCigiSimEntityArtPartPublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiBaseArtPartCtrl, DtCigiSimEntityArtPartPublisher, DtCigiSimEntityComponentPublisherBase >, makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiEntityPublisherBase >, makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiEntityUnpublisher >, makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiFxPublisher, DtCigiEntityPublisherBase >, makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiSimEntityPublisher, DtCigiSimObjectPublisherBase >, makVre::DtCigiPublisherTemplate< CigiBaseEntityPositionCtrl, DtCigiFxPositionPublisher >, makVre::DtCigiPublisherTemplate< CigiBaseEntityPositionCtrl, DtCigiSimEntityPositionPublisher, DtCigiSimEntityComponentPublisherBase >, makVre::DtCigiPublisherTemplate< CigiBaseEnvCtrl, DtCigiTimePublisher, DtCigiPublisherBase >, makVre::DtCigiPublisherTemplate< CigiBaseIGCtrl, DtCigiIgControlPublisher >, makVre::DtCigiPublisherTemplate< CigiBaseRateCtrl, DtCigiFxVelocityPublisher >, makVre::DtCigiPublisherTemplate< CigiBaseRateCtrl, DtCigiSimEntityVelocityPublisher, DtCigiSimEntityComponentPublisherBase >, makVre::DtCigiPublisherTemplate< CigiBaseViewCtrl, DtCigiViewControlPublisher >, makVre::DtCigiPublisherTemplate< CigiBaseViewDef, DtCigiViewDefinitionPublisher >, makVre::DtCigiPublisherTemplate< CigiCelestialCtrlV4, DtCigiTimePublisherV4, DtCigiTimePublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiEntityCtrlV4, DtCigiEntityUnpublisherV4, DtCigiEntityUnpublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiEntityCtrlV4, DtCigiFxPublisherV4, DtCigiFxPublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiEntityCtrlV4, DtCigiSimEntityPublisherV4, DtCigiSimEntityPublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiEntityPositionCtrlV4, DtCigiFxPositionPublisherV4, DtCigiFxPositionPublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiEntityPositionCtrlV4, DtCigiSimEntityPositionPublisherV4, DtCigiSimEntityPositionPublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiIGCtrlV4, DtCigiIgControlPublisherV4, DtCigiIgControlPublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiVelocityCtrlV4, DtCigiFxVelocityPublisherV4, DtCigiFxVelocityPublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiVelocityCtrlV4, DtCigiSimEntityVelocityPublisherV4, DtCigiSimEntityVelocityPublisher, DtCigiDataCreator >, makVre::DtCigiPublisherTemplate< CigiViewCtrlV4, DtCigiViewControlPublisherV4, DtCigiViewControlPublisher, DtCigiDataCreator >, and makVre::DtCigiPublisherTemplate< CigiViewDefV4, DtCigiViewDefinitionPublisherV4, DtCigiViewDefinitionPublisher, DtCigiDataCreator >.

cigiBase() [1/2]

DtCigiDataBase * makVre::DtCigiObjectBase::cigiBase ( )

protected

Referenced by makVre::DtCigiListenerTemplate< CIGI_T, SELF_T, SUPER_T, DATA_CREATOR_T >::cigi(), makVre::DtCigiListenerTemplate< CIGI_T, SELF_T, SUPER_T, DATA_CREATOR_T >::cigi(), makVre::DtCigiPublisherTemplate< CIGI_T, SELF_T, SUPER_T, DATA_CREATOR_T >::cigi(), and makVre::DtCigiPublisherTemplate< CIGI_T, SELF_T, SUPER_T, DATA_CREATOR_T >::cigi().

cigiBase() [2/2]

DtCigiDataBase *const makVre::DtCigiObjectBase::cigiBase ( ) const

protected

updateValue()

template<typename VALUE_T>

bool makVre::DtCigiObjectBase::updateValue ( VALUE_T * value, VALUE_T source )

inlineprotected

Utility function to update value from source and note if the value changed.

References markDirty().

Member Data Documentation

myCigiData

CigiBasePtr makVre::DtCigiObjectBase::myCigiData

protected

mySession

DtCigiSession* makVre::DtCigiObjectBase::mySession

protected

myDirty

bool makVre::DtCigiObjectBase::myDirty

protected

---

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

• include/vrfExtensions/vreCigiHost/cigiObjectBase.h