DtIfServerMessage Class Reference

Instances of DtIfServerMessage are sent out when the server wants to send a status message with category, message and severity. More...

Inheritance diagram for DtIfServerMessage:

List of all members.

Public Types
enum	MessageCategory { Unknown = 0, ScenarioGeneric, ScenarioLoad, UserDefined = 100000 }
Public Member Functions
	DtIfServerMessage ()
	default constructor
virtual	~DtIfServerMessage ()
	destructor
	DtIfServerMessage (const DtIfServerMessage &orig)
	copy constructor
DtIfServerMessage &	operator= (const DtIfServerMessage &orig)
	assignment operator
virtual int	type () const
	Returns the type of Interface Content; DtServerMessageType.
virtual DtSimInterfaceContent *	clone () const
virtual void	setMessage (const std::string &)
virtual std::string	message () const
virtual void	setMessageCategory (MessageCategory)
virtual MessageCategory	messageCategory () const
virtual void	setSeverity (int)
virtual int	severity () const
virtual void	setExtra (int)
virtual int	extra () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Protected Attributes
std::string	myMessage
MessageCategory	myMessageCategory
int	mySeverity
int	myExtra
	Not used currently, however, in case there is any extra information that wants to be passed along, use this value.

---

Detailed Description

Instances of DtIfServerMessage are sent out when the server wants to send a status message with category, message and severity.

The severity is the same as the notify level (DtInfo, DtWarn, etc.). The categories are contained in this header file

---

Member Enumeration Documentation

enum DtIfServerMessage::MessageCategory

Enumerator:

Unknown
ScenarioGeneric
ScenarioLoad
UserDefined

---

Constructor & Destructor Documentation

DtIfServerMessage::DtIfServerMessage

(

)

default constructor

virtual DtIfServerMessage::~DtIfServerMessage

(

)

[virtual]

destructor

DtIfServerMessage::DtIfServerMessage

(

const DtIfServerMessage &

orig

)

copy constructor

---

Member Function Documentation

DtIfServerMessage& DtIfServerMessage::operator=

(

const DtIfServerMessage &

orig

)

assignment operator

virtual int DtIfServerMessage::type

(

)

const [virtual]

Returns the type of Interface Content; DtServerMessageType.

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfServerMessage::clone

(

)

const [virtual]

Implements DtSimInterfaceContent.

virtual void DtIfServerMessage::setMessage

(

const std::string &

)

[virtual]

virtual std::string DtIfServerMessage::message

(

)

const [virtual]

virtual void DtIfServerMessage::setMessageCategory

(

MessageCategory

)

[virtual]

virtual MessageCategory DtIfServerMessage::messageCategory

(

)

const [virtual]

virtual void DtIfServerMessage::setSeverity

(

int

)

[virtual]

virtual int DtIfServerMessage::severity

(

)

const [virtual]

virtual void DtIfServerMessage::setExtra

(

int

)

[virtual]

virtual int DtIfServerMessage::extra

(

)

const [virtual]

virtual int DtIfServerMessage::netRepSize

(

)

const [virtual]

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfServerMessage::setFromNet	(	const char *	contentBuffer,
		unsigned	contentSize
	)		[virtual]

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfServerMessage::setToNet

(

)

[virtual]

Reimplemented from DtSimInterfaceContent.

virtual void DtIfServerMessage::printDataToString

(

DtString &

str

)

[virtual]

Reimplemented from DtSimInterfaceContent.

static DtSimInterfaceContent* DtIfServerMessage::creator

(

)

[static]

---

Member Data Documentation

std::string DtIfServerMessage::myMessage [protected]

MessageCategory DtIfServerMessage::myMessageCategory [protected]

int DtIfServerMessage::mySeverity [protected]

int DtIfServerMessage::myExtra [protected]

Not used currently, however, in case there is any extra information that wants to be passed along, use this value.

---

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

• include/vrfmsgs/ifServerMessage.h