Inheritance diagram for DtUpdateMsg:

Collaboration diagram for DtUpdateMsg:

Public Member Functions
	DtUpdateMsg (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	Constructor.
virtual	~DtUpdateMsg ()
	Destructor.
virtual void	setClassHandle (DtObjectClassHandle hand)=0
	Set/Get handle.
virtual DtObjectClassHandle	classHandle () const =0
virtual void	setObjHandle (DtObjectInstanceHandle id)=0
	Set/Get handle.
virtual DtObjectInstanceHandle	objHandle () const =0
virtual void	setChannel (unsigned long handleValue)
	Set/Get DDM channel.
virtual unsigned long	channel () const
virtual void	setObjName (const char *name)
	Set/Get name.
virtual const char *	objName () const
virtual void	setTag (char const *tag)
	Set/Get tag.
virtual char const *	tag () const
virtual void	setAttrs (const DtAhvps &theAttributes, bool checkBufferSize=true)
	Set attributes.
virtual void	getAttrs (DtAhvps &attrSetBuff, bool useMsgMemory, DtObjectClassInfo objDesc=NULL, DtHandle regionSetHandle=DtDefaultRegionSetHandle, DtRtiObject obj=NULL, float tolerance=0.0) const
	Get attributes Attribute value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.
virtual unsigned long	numAttrs () const
	Get number of parameters.
Static Public Member Functions
static void	setChannelIncluded (bool includeChannel)
	Set/Get flag to include DDM channel identifier.
static bool	channelIncluded ()
Protected Member Functions
virtual void	setNameSize (int size)=0
	Set/Get name size.
virtual int	nameSize () const =0
virtual void	setTagSize (int size)=0
	Set/Get tag size.
virtual int	tagSize () const =0
virtual DtNetU32 *	channelPtr () const =0
	Returns pointer to the channel in the netMsg.
virtual char *	namePtr ()=0
	Returns pointer to the name in the netMsg.
virtual char *	tagPtr ()=0
	Returns pointer to the tag in the netMsg.
virtual DtNetAttrs *	netAttrs ()=0
	Returns pointer to the network rep of the pvList.
virtual DtNetBigAttrs *	netBigAttrs ()=0
	Supports big attribute values > 64K.
virtual DtNetAttrValue *	nextNetAttr (DtNetAttrValue *netAttr) const
	Find pointer to next parameter in the network rep.
virtual DtNetBigAttrValue *	nextNetBigAttr (DtNetBigAttrValue *netAttr) const
	Supports big attribute values > 64K.
virtual void	fillFromNetAttrs (const DtNetAttrs netRepAttrs, DtAhvps &attrs, bool useMsgMemory, DtObjectClassInfo objDesc=NULL, DtHandle regionSetHandle=DtDefaultRegionSetHandle, DtRtiObject *obj=NULL, float tolerance=0.0) const
	Fill the supplied attribute set with the message's attributes Attribute value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.
virtual void	fillFromNetBigAttrs (const DtNetBigAttrs netAttrs, DtAhvps &attrs, bool useMsgMemory, DtObjectClassInfo objDesc=NULL, DtHandle regionSetHandle=DtDefaultRegionSetHandle, DtRtiObject *obj=NULL, float tolerance=0.0) const
	Fill the supplied attribute set with the message's attributes Supports big attribute values > 64K Attribute value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.
virtual void	fillNetAttrs (const DtAhvps &theAttributes, DtNetAttrs *netRepAttrs)
	Fill the message with the given attributes.
virtual void	fillNetBigAttrs (const DtAhvps &attrs, DtNetBigAttrs *netAttrs)
	Supports big attribute values > 64K.
virtual void	setSizeOfNetAttrs (unsigned long size)
	Sets size for the network rep of the pvList.
virtual unsigned long	sizeNeededForNetAttrs (const DtAhvps &attrs) const
	Returns the size the network representation will consume.
virtual int	channelFieldSize () const
	Returns size of serial number field.
virtual int	nameFieldSize () const
	Returns size of name field.
virtual int	tagFieldSize () const
	Returns size of tag field.
virtual DtUpdateMsg *	self () const
	Casts away const-ness.
Protected Attributes
char *	myTag
char *	myName
int	myAttrFieldLength
Static Protected Attributes
static bool	theChannelIncluded = false

Constructor & Destructor Documentation

DtUpdateMsg::DtUpdateMsg ( DtBufferPtr buffer = DtUSE_INTERNAL_BUFFER )

Constructor.

References DtRtiMsg::myAllowedDuringSave, and DtRtiMsg::myConstrained.

DtUpdateMsg::~DtUpdateMsg ( ) [virtual]

Destructor.

References myName, myTag, and NULL.

Member Function Documentation

unsigned long DtUpdateMsg::channel ( ) const [virtual]

References channelIncluded(), channelPtr(), and DtDefaultRegionSetHandle.

Referenced by DtUpdateRoMsg::printData(), and DtObjectMgr::processUpdate().

int DtUpdateMsg::channelFieldSize ( ) const [protected, virtual]

Returns size of serial number field.

References channelIncluded().

Referenced by DtUpdateRoMsg::tagPtr().

bool DtUpdateMsg::channelIncluded ( ) [inline, static]

References theChannelIncluded.

Referenced by DtUpdateRoMsg::addCallback(), channel(), channelFieldSize(), DtUpdateRoMsg::DtUpdateRoMsg(), DtUpdateRoMsg::internalDtRtiMsgKind(), DtUpdateRoMsg::printData(), DtUpdateRoMsg::removeCallback(), and setChannel().

virtual DtNetU32* DtUpdateMsg::channelPtr ( ) const [protected, pure virtual]

Returns pointer to the channel in the netMsg.

Implemented in DtUpdateRoMsg.

Referenced by channel(), and setChannel().

virtual DtObjectClassHandle DtUpdateMsg::classHandle ( ) const [pure virtual]

Implemented in DtUpdateRoMsg.

Referenced by DtObjectMgr::processUpdate().

void DtUpdateMsg::fillFromNetAttrs	(	const DtNetAttrs *	netRepAttrs,
		DtAhvps &	attrs,
		bool	useMsgMemory,
		DtObjectClassInfo *	objDesc = `NULL`,
		DtHandle	regionSetHandle = `DtDefaultRegionSetHandle`,
		DtRtiObject *	obj = `NULL`,
		float	tolerance = `0.0`
	)		const `[protected, virtual]`

Fill the supplied attribute set with the message's attributes Attribute value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.

References DtNetAttrValue::handle, DtObjectClassInfo::isSubscribed(), nextNetAttr(), DtNetAttrs::numAttrs, numAttrs(), DtRtiObject::okToReceive(), and DtNetAttrValue::size.

Referenced by getAttrs().

void DtUpdateMsg::fillFromNetBigAttrs	(	const DtNetBigAttrs *	netAttrs,
		DtAhvps &	attrs,
		bool	useMsgMemory,
		DtObjectClassInfo *	objDesc = `NULL`,
		DtHandle	regionSetHandle = `DtDefaultRegionSetHandle`,
		DtRtiObject *	obj = `NULL`,
		float	tolerance = `0.0`
	)		const `[protected, virtual]`

Fill the supplied attribute set with the message's attributes Supports big attribute values > 64K Attribute value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.

References DtNetBigAttrValue::handle, DtObjectClassInfo::isSubscribed(), nextNetBigAttr(), DtNetBigAttrs::numAttrs, numAttrs(), DtRtiObject::okToReceive(), and DtNetBigAttrValue::size.

Referenced by getAttrs().

void DtUpdateMsg::fillNetAttrs	(	const DtAhvps &	theAttributes,
		DtNetAttrs *	netRepAttrs
	)		`[protected, virtual]`

Fill the message with the given attributes.

References DtNetAttrValue::handle, nextNetAttr(), DtNetAttrs::numAttrs, and DtNetAttrValue::size.

Referenced by setAttrs().

void DtUpdateMsg::fillNetBigAttrs	(	const DtAhvps &	attrs,
		DtNetBigAttrs *	netAttrs
	)		`[protected, virtual]`

Supports big attribute values > 64K.

References DtNetBigAttrValue::handle, nextNetBigAttr(), DtNetBigAttrs::numAttrs, and DtNetBigAttrValue::size.

Referenced by setAttrs().

void DtUpdateMsg::getAttrs	(	DtAhvps &	attrSetBuff,
		bool	useMsgMemory,
		DtObjectClassInfo *	objDesc = `NULL`,
		DtHandle	regionSetHandle = `DtDefaultRegionSetHandle`,
		DtRtiObject *	obj = `NULL`,
		float	tolerance = `0.0`
	)		const `[virtual]`

Get attributes Attribute value set allocates own memory for values or accesses the message's memory directly Fills in only subscribed attributes if class info is provided otherwise gets all attributes in message.

References fillFromNetAttrs(), fillFromNetBigAttrs(), netAttrs(), netBigAttrs(), and DtRtiMsg::use32BitsForValueSize().

Referenced by DtUpdateRoMsg::printData(), and DtObjectMgr::processUpdate().

int DtUpdateMsg::nameFieldSize ( ) const [protected, virtual]

Returns size of name field.

References nameSize().

Referenced by DtUpdateRoMsg::DtUpdateRoMsg(), DtUpdateRoMsg::netAttrs(), DtUpdateRoMsg::netBigAttrs(), and setObjName().

virtual char* DtUpdateMsg::namePtr ( ) [protected, pure virtual]

Returns pointer to the name in the netMsg.

Implemented in DtUpdateRoMsg.

Referenced by objName(), and setObjName().

virtual int DtUpdateMsg::nameSize ( ) const [protected, pure virtual]

Implemented in DtUpdateRoMsg.

Referenced by nameFieldSize(), objName(), and setObjName().

virtual DtNetAttrs* DtUpdateMsg::netAttrs ( ) [protected, pure virtual]

Returns pointer to the network rep of the pvList.

Implemented in DtUpdateRoMsg.

Referenced by getAttrs(), numAttrs(), setAttrs(), and setSizeOfNetAttrs().

virtual DtNetBigAttrs* DtUpdateMsg::netBigAttrs ( ) [protected, pure virtual]

Supports big attribute values > 64K.

Implemented in DtUpdateRoMsg.

Referenced by getAttrs(), numAttrs(), and setAttrs().

DtNetAttrValue * DtUpdateMsg::nextNetAttr ( DtNetAttrValue * netAttr ) const [protected, virtual]

Find pointer to next parameter in the network rep.

References DtNetAttrValue::totalSize().

Referenced by fillFromNetAttrs(), and fillNetAttrs().

DtNetBigAttrValue * DtUpdateMsg::nextNetBigAttr ( DtNetBigAttrValue * netAttr ) const [protected, virtual]

Supports big attribute values > 64K.

References DtNetBigAttrValue::totalSize().

Referenced by fillFromNetBigAttrs(), and fillNetBigAttrs().

unsigned long DtUpdateMsg::numAttrs ( ) const [virtual]

Get number of parameters.

References netAttrs(), netBigAttrs(), DtNetAttrs::numAttrs, DtNetBigAttrs::numAttrs, and DtRtiMsg::use32BitsForValueSize().

Referenced by fillFromNetAttrs(), fillFromNetBigAttrs(), DtUpdateRoMsg::printData(), and DtObjectMgr::processUpdate().

virtual DtObjectInstanceHandle DtUpdateMsg::objHandle ( ) const [pure virtual]

Implemented in DtUpdateRoMsg.

Referenced by DtObjectMgr::processUpdate().

const char * DtUpdateMsg::objName ( ) const [virtual]

References myName, namePtr(), and nameSize().

Referenced by DtUpdateRoMsg::printData(), and DtObjectMgr::processUpdate().

DtUpdateMsg * DtUpdateMsg::self ( ) const [inline, protected, virtual]

Casts away const-ness.

void DtUpdateMsg::setAttrs	(	const DtAhvps &	theAttributes,
		bool	checkBufferSize = `true`
	)		`[virtual]`

Set attributes.

References fillNetAttrs(), fillNetBigAttrs(), netAttrs(), netBigAttrs(), setSizeOfNetAttrs(), sizeNeededForNetAttrs(), and DtRtiMsg::use32BitsForValueSize().

Referenced by DtUpdateRoMsg::DtUpdateRoMsg().

void DtUpdateMsg::setChannel ( unsigned long handleValue ) [virtual]

Set/Get DDM channel.

References channelIncluded(), and channelPtr().

Referenced by DtUpdateRoMsg::DtUpdateRoMsg().

void DtUpdateMsg::setChannelIncluded ( bool includeChannel ) [static]

Set/Get flag to include DDM channel identifier.

References theChannelIncluded.

Referenced by DtObjectMgr::DtObjectMgr(), and DtConnectionMgr::initParams().

virtual void DtUpdateMsg::setClassHandle ( DtObjectClassHandle hand ) [pure virtual]

Set/Get handle.

Implemented in DtUpdateRoMsg.

virtual void DtUpdateMsg::setNameSize ( int size ) [protected, pure virtual]

Set/Get name size.

Implemented in DtUpdateRoMsg.

Referenced by setObjName().

virtual void DtUpdateMsg::setObjHandle ( DtObjectInstanceHandle id ) [pure virtual]

Set/Get handle.

Implemented in DtUpdateRoMsg.

void DtUpdateMsg::setObjName ( const char * name ) [virtual]

Set/Get name.

References DtRtiMsg::adjustBytes(), myName, nameFieldSize(), namePtr(), nameSize(), NULL, and setNameSize().

Referenced by DtUpdateRoMsg::DtUpdateRoMsg().

void DtUpdateMsg::setSizeOfNetAttrs ( unsigned long size ) [protected, virtual]

Sets size for the network rep of the pvList.

References DtRtiMsg::adjustBytes(), myAttrFieldLength, and netAttrs().

Referenced by setAttrs().

void DtUpdateMsg::setTag ( char const * tag ) [virtual]

Set/Get tag.

References DtRtiMsg::adjustBytes(), myTag, NULL, setTagSize(), tagFieldSize(), tagPtr(), and tagSize().

Referenced by DtUpdateRoMsg::DtUpdateRoMsg().

virtual void DtUpdateMsg::setTagSize ( int size ) [protected, pure virtual]

Set/Get tag size.

Implemented in DtUpdateRoMsg.

Referenced by setTag().

unsigned long DtUpdateMsg::sizeNeededForNetAttrs ( const DtAhvps & attrs ) const [protected, virtual]

Returns the size the network representation will consume.

References DtRtiMsg::use32BitsForValueSize().

Referenced by setAttrs().

const char * DtUpdateMsg::tag ( ) const [virtual]

References myTag, NULL, tagPtr(), and tagSize().

Referenced by DtUpdateRoMsg::printData(), and DtObjectMgr::processUpdate().

int DtUpdateMsg::tagFieldSize ( ) const [protected, virtual]

Returns size of tag field.

References tagSize().

Referenced by DtUpdateRoMsg::DtUpdateRoMsg(), DtUpdateRoMsg::namePtr(), and setTag().

virtual char* DtUpdateMsg::tagPtr ( ) [protected, pure virtual]

Returns pointer to the tag in the netMsg.

Implemented in DtUpdateRoMsg.

Referenced by setTag(), and tag().

virtual int DtUpdateMsg::tagSize ( ) const [protected, pure virtual]

Implemented in DtUpdateRoMsg.

Referenced by setTag(), tag(), and tagFieldSize().

Member Data Documentation

int DtUpdateMsg::myAttrFieldLength [protected]

Referenced by DtUpdateRoMsg::DtUpdateRoMsg(), and setSizeOfNetAttrs().

char* DtUpdateMsg::myName [protected]

Referenced by objName(), setObjName(), and ~DtUpdateMsg().

char* DtUpdateMsg::myTag [protected]

Referenced by setTag(), tag(), and ~DtUpdateMsg().

bool DtUpdateMsg::theChannelIncluded = false [static, protected]

Referenced by channelIncluded(), and setChannelIncluded().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation