makVre::DtCigiEntityPublisherBase Class Reference

#include <cigiEntityPublisherBase.h>

Inheritance diagram for makVre::DtCigiEntityPublisherBase:

Public Member Functions
	DtCigiEntityPublisherBase ()
virtual	~DtCigiEntityPublisherBase () override
virtual Cigi_uint16	cigiId () const
virtual bool	init () override
Public Member Functions inherited from makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiEntityPublisherBase >
	DtCigiPublisherTemplate ()
virtual	~DtCigiPublisherTemplate () override
CigiData *	cigi ()
CigiData *const	cigi () const
CigiData *	shared ()
CigiData *const	shared () const
Public Member Functions inherited from makVre::DtSpSubClass< DtCigiEntityPublisherBase, DtCigiPublisherBase >
	DtSpSubClass ()
virtual	~DtSpSubClass ()
Sptr	self ()
std::string	type () const override
Public Member Functions inherited from makVre::DtCigiPublisherBase
	DtCigiPublisherBase ()
virtual	~DtCigiPublisherBase () override
DtCigiDataBase *	shared ()
DtCigiDataBase *const	shared () const
virtual void	setEnabled (bool enabled)
virtual bool	enabled () const
virtual void	tick (double dt)
template<class CHILD_T>
std::shared_ptr< CHILD_T >	addNewChild (const std::string &name="")
virtual bool	addChild (Sptr child) override
virtual void	publish (CigiOutgoingMsg &out)
virtual void	setNeedsReceiptConfirmation (bool needs)
virtual bool	needsReceiptConfirmation () const
virtual void	receiptConfirmed ()
virtual double	lastSent ()
virtual void	markDirty (bool childrenToo=false)
virtual void	markClean (bool childrenToo=false)
Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
	DtSpSubClass ()
Sptr	self ()
std::string	type () const override
Public Member Functions inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
	DtTreeClass ()
virtual	~DtTreeClass () override
virtual void	setOwnsChildren (bool owns)
virtual bool	ownsChildren ()
virtual bool	removeChild (Sptr child)
virtual void	removeAllChildren ()
virtual bool	forEachChild (ForChildFn fn)
virtual Sptr	findChild (FindChildFn fn)
virtual Sptr	findChild (const std::string &name)
virtual bool	isChild (Sptr child)
virtual unsigned int	numChildren ()
virtual bool	hasChildren ()
virtual Sptr	parent ()
Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
	DtSpSubClass ()
Sptr	self ()
Public Member Functions inherited from makVre::DtCigiObjectBase
	DtCigiObjectBase ()
virtual	~DtCigiObjectBase () override
CigiData *	cigi ()
CigiData *const	cigi () const
virtual Cigi_uint16	cigiType ()
virtual Sptr	setSession (DtCigiSession &session)
virtual DtCigiSession &	session () const
virtual unsigned int	sessionVersion () const
virtual void	markDirty ()
virtual void	markClean ()
virtual bool	isDirty () const
Public Member Functions inherited from makVre::DtSpSubClass< DtCigiObjectBase >
	DtSpSubClass ()
Sptr	self ()
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 void	initCigi () override
virtual void	tickChildren (double dt) override
virtual void	publishChildren (CigiOutgoingMsg &out) override
virtual void	unpublish ()
Protected Member Functions inherited from makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiEntityPublisherBase >
DtCigiDataBase *	createCigi () override
bool	verifySharedType () override
Protected Member Functions inherited from makVre::DtCigiPublisherBase
virtual std::string	sharedKey ()
virtual void	setupShared ()
virtual void	initShared ()
virtual void	updateShared ()
virtual void	updateCigi ()
virtual void	write (CigiOutgoingMsg &out)
virtual void	createChildren ()
Protected Member Functions inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
virtual void	setParent (Sptr parent)
virtual void	pruneChildren ()
Protected Member Functions inherited from makVre::DtCigiObjectBase
DtCigiDataBase *	cigiBase ()
DtCigiDataBase *const	cigiBase () const
template<typename VALUE_T>
bool	updateValue (VALUE_T *value, VALUE_T source)

Additional Inherited Members
Public Types inherited from makVre::DtCigiPublisherTemplate< CigiBaseEntityCtrl, DtCigiEntityPublisherBase >
using	Cigi
using	CigiData
Public Types inherited from makVre::DtSpSubClass< DtCigiEntityPublisherBase, DtCigiPublisherBase >
using	Super
using	Ptr
using	Sptr
using	Wptr
Public Types inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
using	Super
using	Ptr
using	Sptr
using	Wptr
Public Types inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
using	Sptr
using	ForChildFn
using	FindChildFn
Public Types inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
using	Super
using	Ptr
using	Sptr
using	Wptr
Public Types inherited from makVre::DtCigiObjectBase
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>
Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiEntityPublisherBase, DtCigiPublisherBase >
static std::string	Type ()
static std::shared_ptr< DtCigiEntityPublisherBase >	create ()
static void	registerCreator ()
static std::shared_ptr< DtCigiEntityPublisherBase >	createVersion (unsigned int version)
static void	registerCreatorVersion (unsigned int version)
Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
static std::string	Type ()
static std::shared_ptr< DtCigiPublisherBase >	create ()
static void	registerCreator ()
static std::shared_ptr< DtCigiPublisherBase >	createVersion (unsigned int version)
static void	registerCreatorVersion (unsigned int version)
Static Public Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
static std::string	Type ()
static std::shared_ptr< DtCigiPublisherBase >	create ()
static void	registerCreator ()
static std::shared_ptr< DtCigiPublisherBase >	createVersion (unsigned int version)
static void	registerCreatorVersion (unsigned int version)
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)
Protected Types inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
using	Wptr
using	OwnedChildList
using	UnownedChildList
using	ChildNameMap
Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiEntityPublisherBase, DtCigiPublisherBase >
static std::shared_ptr< DtBaseCreator< DtCigiEntityPublisherBase > > &	creator ()
static std::shared_ptr< DtBaseCreator< DtCigiEntityPublisherBase > > &	creatorVersion (unsigned int version)
Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase > >
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > &	creator ()
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > &	creatorVersion (unsigned int version)
Static Protected Member Functions inherited from makVre::DtSpSubClass< DtCigiPublisherBase, DtCigiObjectBase >
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > &	creator ()
static std::shared_ptr< DtBaseCreator< DtCigiPublisherBase > > &	creatorVersion (unsigned int version)
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)
Protected Attributes inherited from makVre::DtCigiPublisherBase
CigiBasePtr	mySharedData
bool	myEnabled
bool	myNeedsConfirmation
double	myLastSentToIg
Protected Attributes inherited from makVre::DtTreeClass< DtCigiPublisherBase, DtCigiObjectBase >
OwnedChildList	myOwnedChildren
UnownedChildList	myUnownedChildren
ChildNameMap	myChildrenByName
bool	myOwnsChildren
Wptr	myParent
Protected Attributes inherited from makVre::DtCigiObjectBase
CigiBasePtr	myCigiData
DtCigiSession *	mySession
bool	myDirty
Protected Attributes inherited from makVre::DtSpObject
std::string	myName

Constructor & Destructor Documentation

DtCigiEntityPublisherBase()

makVre::DtCigiEntityPublisherBase::DtCigiEntityPublisherBase ( )

inline

~DtCigiEntityPublisherBase()

virtual makVre::DtCigiEntityPublisherBase::~DtCigiEntityPublisherBase ( )

overridevirtual

Member Function Documentation

cigiId()

virtual Cigi_uint16 makVre::DtCigiEntityPublisherBase::cigiId ( ) const

virtual

init()

virtual bool makVre::DtCigiEntityPublisherBase::init ( )

overridevirtual

Reimplemented from makVre::DtCigiPublisherBase.

Reimplemented in makVre::DtCigiSimObjectPublisherBase.

initCigi()

virtual void makVre::DtCigiEntityPublisherBase::initCigi ( )

overrideprotectedvirtual

Derived Publisher classes should override initCigi() to set initial values in the CIGI data.

Reimplemented from makVre::DtCigiPublisherBase.

Reimplemented in makVre::DtCigiFxPublisher, makVre::DtCigiFxPublisherV4, and makVre::DtCigiSimEntityPublisherV4.

tickChildren()

virtual void makVre::DtCigiEntityPublisherBase::tickChildren ( double dt )

overrideprotectedvirtual

Reimplemented from makVre::DtCigiPublisherBase.

Reimplemented in makVre::DtCigiFxPublisher.

publishChildren()

virtual void makVre::DtCigiEntityPublisherBase::publishChildren ( CigiOutgoingMsg & out )

overrideprotectedvirtual

Reimplemented from makVre::DtCigiPublisherBase.

Reimplemented in makVre::DtCigiFxPublisher.

unpublish()

virtual void makVre::DtCigiEntityPublisherBase::unpublish ( )

protectedvirtual

Invoked from destructor. Should create DtCigiEntityUnpublisher to handle publishing of entity removal flag and cleanup upon receipt.

Reimplemented in makVre::DtCigiFxPublisher.

---

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

• include/vrfExtensions/vreCigiHost/cigiEntityPublisherBase.h