Detailed Description

template<class CIGI_T, class SELF_T, class SUPER_T = DtCigiPublisherBase, class DATA_CREATOR_T = DtCigiDataCreatorStub>
class makVre::DtCigiPublisherTemplate< CIGI_T, SELF_T, SUPER_T, DATA_CREATOR_T >

Handles implementation of cigi(), createCigi(), shared() and verifySharedType()

The final DATA_CREATOR_T type parameter is optional. Use the default DtCigiDataCreatorStub when implementing an abstract base Publisher class using an abstract base CIGI_t type. Use DtCigiDataCreator when implementing a concreate/final Publisher class (typcially versioned).

Template Parameters

CIGI_T	Type of the CIGI packet class to be managed by this Publisher
SELF_T	Type of the class implementing this template
SUPER_T	Parent Publisher from which SELF_T Publisher type should be derived, default is DtCigiPublisherBase
DATA_CREATOR_T	One of DtCigiDataCreatorStub or DtCigiDataCreator

#include <cigiPublisherTemplate.h>

Inheritance diagram for makVre::DtCigiPublisherTemplate< CIGI_T, SELF_T, SUPER_T, DATA_CREATOR_T >:

[legend]

Public Types
using	Cigi = CIGI_T

using	CigiData = DtCigiDataTemplate<CIGI_T, SELF_T>

Public Types inherited from makVre::DtSpSubClass< SELF_T, 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>

Public Member Functions
	DtCigiPublisherTemplate ()

virtual	~DtCigiPublisherTemplate () override

CigiData *	cigi ()

CigiData *const	cigi () const

CigiData *	shared ()

CigiData *const	shared () const

Public Member Functions inherited from makVre::DtSpSubClass< SELF_T, 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 bool	init () override

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 ()

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
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	initCigi ()

virtual void	updateShared ()

virtual void	updateCigi ()

virtual void	write (CigiOutgoingMsg &out)

virtual void	createChildren ()

virtual void	tickChildren (double dt)

virtual void	publishChildren (CigiOutgoingMsg &out)

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
Static Public Member Functions inherited from makVre::DtSpSubClass< SELF_T, DtCigiPublisherBase >
static std::string	Type ()

static std::shared_ptr< SELF_T >	create ()

static void	registerCreator ()

static std::shared_ptr< SELF_T >	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< SELF_T, DtCigiPublisherBase >
static std::shared_ptr< DtBaseCreator< SELF_T > > &	creator ()

static std::shared_ptr< DtBaseCreator< SELF_T > > &	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