DtIfUnassignRolePlayer Class Reference

Detailed Description

Instances of DtIfUnassignRolePlayer messages are sent out by a VRF GUI application to unassign a player from an entity at a particular VREngage station. This message includes information about the player's VREngage application ID and the entity that will no longer be controlled.

#include <ifUnassignRolePlayer.h>

Inheritance diagram for DtIfUnassignRolePlayer:

Public Member Functions
	DtIfUnassignRolePlayer ()
virtual	~DtIfUnassignRolePlayer () override
	DtIfUnassignRolePlayer (const DtIfUnassignRolePlayer &orig)
DtIfUnassignRolePlayer &	operator= (const DtIfUnassignRolePlayer &orig)
virtual int	type () const override
virtual DtSimInterfaceContent *	clone () const override
virtual void	setId (unsigned long id)
virtual unsigned long	id () const
virtual void	setUUID (const DtString &uuid)
virtual DtString	uuid () const
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
virtual void	printDataToString (DtString &str) override

Static Public Member Functions
static DtSimInterfaceContent *	creator ()

Protected Attributes
DtU32	myVersion
DtU64	myId
DtString	myUUID

Constructor & Destructor Documentation

DtIfUnassignRolePlayer() [1/2]

DtIfUnassignRolePlayer::DtIfUnassignRolePlayer

(

)

Default constructor.

Initializes an empty unassign role player message.

Referenced by DtIfUnassignRolePlayer(), and operator=().

~DtIfUnassignRolePlayer()

virtual DtIfUnassignRolePlayer::~DtIfUnassignRolePlayer ( )

overridevirtual

Virtual destructor.

DtIfUnassignRolePlayer() [2/2]

DtIfUnassignRolePlayer::DtIfUnassignRolePlayer

(

const DtIfUnassignRolePlayer &

orig

)

Copy constructor.

Parameters

orig	The unassign role player message to copy from

Creates a new unassign role player message by copying an existing one.

References DtIfUnassignRolePlayer().

Member Function Documentation

operator=()

DtIfUnassignRolePlayer & DtIfUnassignRolePlayer::operator=

(

const DtIfUnassignRolePlayer &

orig

)

Assignment operator.

Parameters

orig	The unassign role player message to copy from

Returns

Reference to this object after assignment

Copies the contents of another unassign role player message into this one.

References DtIfUnassignRolePlayer().

type()

virtual int DtIfUnassignRolePlayer::type ( ) const

overridevirtual

Gets the interface message type.

Returns

The message type identifier

Returns DtUnassignRolePlayerMessageType as defined in vreVrfMessageTypes.h.

clone()

virtual DtSimInterfaceContent * DtIfUnassignRolePlayer::clone ( ) const

overridevirtual

Creates a copy of this message.

Returns

Pointer to the new copy

Creates a dynamically allocated copy of this message.

setId()

virtual void DtIfUnassignRolePlayer::setId ( unsigned long id )

virtual

Sets the identifier of the VREngage application.

Parameters

id	The unique identifier to set

Sets the unique identifier for the VREngage application. This must be unique across all VREngage stations in an exercise and must not change over the lifetime of the application.

id()

virtual unsigned long DtIfUnassignRolePlayer::id ( ) const

virtual

Gets the identifier of the VREngage application.

Returns

The VREngage application identifier

setUUID()

virtual void DtIfUnassignRolePlayer::setUUID ( const DtString & uuid )

virtual

Sets the UUID of the entity being unassigned.

Parameters

uuid	The entity UUID to set

Sets the UUID of the entity that will no longer be controlled by the VREngage station.

References uuid().

uuid()

virtual DtString DtIfUnassignRolePlayer::uuid ( ) const

virtual

Gets the UUID of the entity being unassigned.

Returns

The entity UUID

Referenced by setUUID().

netRepSize()

virtual int DtIfUnassignRolePlayer::netRepSize ( ) const

overridevirtual

Gets the network representation size.

Returns

Size in bytes of the network representation

Returns the size of the network buffer needed to store this message.

setFromNet()

virtual bool DtIfUnassignRolePlayer::setFromNet ( const char * contentBuffer, unsigned contentSize )

overridevirtual

Deserializes the message from a network buffer.

Parameters

contentBuffer	Pointer to the network buffer
contentSize	Size of the buffer in bytes

Returns

True if deserialization was successful

Fills the message from the provided network buffer.

setToNet()

virtual bool DtIfUnassignRolePlayer::setToNet ( )

overridevirtual

Serializes the message for network transmission.

Returns

True if serialization was successful

Prepares the message for network transmission.

printDataToString()

virtual void DtIfUnassignRolePlayer::printDataToString ( DtString & str )

overridevirtual

Formats the message data as a string.

Parameters

str	String to store the formatted message data

Appends a human-readable representation of the message to the provided string.

creator()

static DtSimInterfaceContent * DtIfUnassignRolePlayer::creator ( )

static

Static creator function for factory registration.

Returns

Pointer to a new instance of DtIfUnassignRolePlayer

This static function is used for registration with DtInterfaceContentFactory.

Member Data Documentation

myVersion

DtU32 DtIfUnassignRolePlayer::myVersion

protected

Version information for the message.

The high word is a signal that the version exists, and the low word is the actual version. If this information does not exist, it is assumed to be an older status message.

myId

DtU64 DtIfUnassignRolePlayer::myId

protected

Unique identifier for the VREngage application.

Must be unique across all VREngage stations in an exercise and must not change over the lifetime of the application.

myUUID

DtString DtIfUnassignRolePlayer::myUUID

protected

UUID of the entity being unassigned.

This is the UUID of the entity that will no longer be controlled by the VREngage station.

---

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

• include/vrfExtensions/vreVrfMessages/ifUnassignRolePlayer.h