DtChatInter Class Reference

Instances of DtChatInter are used to store state data for resourceRequest interactions.

Instances of DtChatInter are used to send Chat interaction messages.

Inheritance diagram for DtChatInter:

Public Member Functions
	DtChatInter (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
virtual	~DtChatInter () override
	DtChatInter (const DtChatInter &orig)
DtChatInter &	operator= (const DtChatInter &orig)
virtual void	setSender (const DtEntityIdentifier &val)
virtual DtEntityIdentifier	sender () const
virtual void	setSenderUsername (const std::wstring &val)
virtual std::wstring	senderUsername () const
virtual void	setChannel (const std::wstring &val)
virtual std::wstring	channel () const
virtual void	setForceIdentifier (DtForceType val)
virtual DtForceType	forceIdentifier () const
virtual void	setMessageText (const std::wstring &val)
virtual std::wstring	messageText () const
virtual const char *	name () const
virtual void	printData () const override
virtual void	printDataToStream (std::ostream &stream) const override
	DtChatInter ()
virtual	~DtChatInter () override
	DtChatInter (const DtChatInter &orig)
DtChatInter &	operator= (const DtChatInter &orig)
virtual void	printData () const override
virtual void	printDataToStream (std::ostream &stream) const override
virtual void	setSender (const DtEntityIdentifier &val)
virtual DtEntityIdentifier	sender () const
virtual void	setSenderUsername (const std::wstring &val)
virtual std::wstring	senderUsername () const
virtual void	setChannel (const std::wstring &val)
virtual std::wstring	channel () const
virtual void	setForceIdentifier (DtForceType val)
virtual DtForceType	forceIdentifier () const
virtual void	setMessageText (const std::wstring &val)
virtual std::wstring	messageText () const
virtual const char *	name () const override

Static Public Member Functions
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
static void	addCallback (DtExerciseConn *conn, DtChatInterInterCb cb, void *usr)
static void	removeCallback (DtExerciseConn *conn, DtChatInterInterCb cb, void *usr)
static DtInteraction *	create ()
static void	addCallback (DtExerciseConn *conn, DtChatInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())
static void	removeCallback (DtExerciseConn *conn, DtChatInterCb cb, void *usr, DtDDMRegionSP region=DtDDMRegionSP())

Protected Member Functions
	DtChatInter (const DtNetPacket *pkt, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
virtual void	readVariableSizedData ()
virtual unsigned int	fixedBytesSize () const
virtual char *	firstVarDatumStart () const
unsigned int	minimumSize () const
virtual unsigned	netSizeOfWString (const std::wstring &val) const
virtual void	writeWString (char *buffer, const std::wstring &val)
virtual void	readWString (char *buffer, std::wstring &val) const
virtual DtPduKind	internalGetPduKind () const override
virtual const char *	interactionClassToUse (DtExerciseConn *exConn) const override
virtual DtInteractionDecoder *	createDecoder (DtExerciseConn *exConn) const override
virtual DtInteractionEncoder *	createEncoder (DtExerciseConn *exConn) const override

Static Protected Member Functions
static DtPduKind	internalGetPduKindImpl ()

Protected Attributes
std::wstring	mySenderUsername
std::wstring	myChannel
std::wstring	myMessageText
DtEntityIdentifier	mySender
DtForceType	myForceIdentifier

Constructor & Destructor Documentation

DtChatInter::DtChatInter

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

Constructor.

virtual DtChatInter::~DtChatInter ( )

overridevirtual

Destructor.

DtChatInter::DtChatInter

(

const DtChatInter &

orig

)

Copy constructor.

DtChatInter::DtChatInter ( const DtNetPacket *  pkt, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory *  pduFactory = 0  )

protected

Constructor from an incoming packet. Use the create() method.

DtChatInter::DtChatInter

(

)

Constructor.

virtual DtChatInter::~DtChatInter ( )

overridevirtual

Destructor.

DtChatInter::DtChatInter

(

const DtChatInter &

orig

)

Copy constructor.

Member Function Documentation

DtChatInter& DtChatInter::operator=

(

const DtChatInter &

orig

)

Assignment operator.

virtual void DtChatInter::setSender ( const DtEntityIdentifier &  val )

virtual

Sender mutator.

virtual DtEntityIdentifier DtChatInter::sender ( ) const

virtual

Sender accessor.

virtual void DtChatInter::setSenderUsername ( const std::wstring &  val )

virtual

SenderUsername mutator.

virtual std::wstring DtChatInter::senderUsername ( ) const

virtual

SenderUsername accessor.

virtual void DtChatInter::setChannel ( const std::wstring &  val )

virtual

Channel mutator.

virtual std::wstring DtChatInter::channel ( ) const

virtual

Channel accessor.

virtual void DtChatInter::setForceIdentifier ( DtForceType  val )

virtual

ForceIdentifier mutator.

virtual DtForceType DtChatInter::forceIdentifier ( ) const

virtual

ForceIdentifier accessor.

virtual void DtChatInter::setMessageText ( const std::wstring &  val )

virtual

MessageText mutator.

virtual std::wstring DtChatInter::messageText ( ) const

virtual

MessageText accessor.

virtual const char* DtChatInter::name ( void  ) const

inlinevirtual

Name of the interaction.

virtual void DtChatInter::printData ( ) const

overridevirtual

Print the interaction's data.

virtual void DtChatInter::printDataToStream ( std::ostream &  stream ) const

overridevirtual

Print the interaction's data to the specified stream.

static DtPdu* DtChatInter::create ( const DtNetPacket *  initial, DtBufferPtr  buffer = DtUSE_INTERNAL_BUFFER, DtPduFactory *  pduFactory = 0  )

static

Create a DtChatInter. Caller is responsible for deletion.

static void DtChatInter::addCallback ( DtExerciseConn *  conn, DtChatInterInterCb  cb, void *  usr  )

static

Add (register)/Remove (deregister) function to be called when interaction occurs.

static void DtChatInter::removeCallback ( DtExerciseConn *  conn, DtChatInterInterCb  cb, void *  usr  )

static

virtual void DtChatInter::readVariableSizedData ( )

protectedvirtual

virtual unsigned int DtChatInter::fixedBytesSize ( ) const

protectedvirtual

virtual char* DtChatInter::firstVarDatumStart ( ) const

protectedvirtual

unsigned int DtChatInter::minimumSize ( ) const

protected

virtual unsigned DtChatInter::netSizeOfWString ( const std::wstring &  val ) const

protectedvirtual

virtual void DtChatInter::writeWString ( char *  buffer, const std::wstring &  val  )

protectedvirtual

virtual void DtChatInter::readWString ( char *  buffer, std::wstring &  val  ) const

protectedvirtual

static DtPduKind DtChatInter::internalGetPduKindImpl ( )

inlinestaticprotected

References DtChatPduKind.

virtual DtPduKind DtChatInter::internalGetPduKind ( ) const

inlineoverrideprotectedvirtual

DtChatInter& DtChatInter::operator=

(

const DtChatInter &

orig

)

Assignment operator.

virtual void DtChatInter::printData ( ) const

overridevirtual

Print the interaction's data.

virtual void DtChatInter::printDataToStream ( std::ostream &  stream ) const

overridevirtual

Print the interaction's data to the specified stream.

virtual void DtChatInter::setSender ( const DtEntityIdentifier &  val )

virtual

Sender mutator.

virtual DtEntityIdentifier DtChatInter::sender ( ) const

virtual

Sender accessor.

virtual void DtChatInter::setSenderUsername ( const std::wstring &  val )

virtual

SenderUsername mutator.

virtual std::wstring DtChatInter::senderUsername ( ) const

virtual

SenderUsername accessor.

virtual void DtChatInter::setChannel ( const std::wstring &  val )

virtual

Channel mutator.

virtual std::wstring DtChatInter::channel ( ) const

virtual

Channel accessor.

virtual void DtChatInter::setForceIdentifier ( DtForceType  val )

virtual

ForceIdentifier mutator.

virtual DtForceType DtChatInter::forceIdentifier ( ) const

virtual

ForceIdentifier accessor.

virtual void DtChatInter::setMessageText ( const std::wstring &  val )

virtual

MessageText mutator.

virtual std::wstring DtChatInter::messageText ( ) const

virtual

MessageText accessor.

virtual const char* DtChatInter::name ( void  ) const

inlineoverridevirtual

Name of the interaction. (Not necessarily the ClassName from the FOM.)

static DtInteraction* DtChatInter::create ( )

static

Create a DtChatInter. Caller is responsible for deletion.

static void DtChatInter::addCallback ( DtExerciseConn *  conn, DtChatInterCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

Add (register)/Remove (deregister) function to be called when interaction occurs.

static void DtChatInter::removeCallback ( DtExerciseConn *  conn, DtChatInterCb  cb, void *  usr, DtDDMRegionSP  region = DtDDMRegionSP()  )

static

virtual const char* DtChatInter::interactionClassToUse ( DtExerciseConn *  exConn ) const

overrideprotectedvirtual

virtual DtInteractionDecoder* DtChatInter::createDecoder ( DtExerciseConn *  exConn ) const

overrideprotectedvirtual

virtual DtInteractionEncoder* DtChatInter::createEncoder ( DtExerciseConn *  exConn ) const

overrideprotectedvirtual

Member Data Documentation

std::wstring DtChatInter::mySenderUsername

mutableprotected

std::wstring DtChatInter::myChannel

mutableprotected

std::wstring DtChatInter::myMessageText

mutableprotected

DtEntityIdentifier DtChatInter::mySender

protected

DtForceType DtChatInter::myForceIdentifier

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfExtObjects/chatInterDIS.h
• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfExtObjects/chatInterHLA.h