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:

Public Types
enum	MessageCategory {   Unknown = 0, ScenarioGeneric, ScenarioLoad, ScenarioSave,   ScenarioCheckpointSaved, 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	addExtra (const std::string &, const std::string &)
const std::map< std::string, std::string >	extra () const
virtual std::string	extraValue (const std::string &key) const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
Public Member Functions inherited from DtSimInterfaceContent
virtual	~DtSimInterfaceContent ()
virtual bool	update (const DtSimInterfaceContent *data)
virtual char *	netRep ()
virtual void	printContentType (DtString &str)
virtual void	setUseSessionId (bool yesNo)
virtual bool	useSessionId () const

Static Public Member Functions
static DtSimInterfaceContent *	creator ()
Static Public Member Functions inherited from DtSimInterfaceContent
static DtSimInterfaceContent *	createInterfaceContent (int type)
static void	addInterfaceContentCreatorFcn (int type, DtInterfaceContentCreatorFcn fcn)
static void	setFactory (DtInterfaceContentFactory *factory)
static DtInterfaceContentFactory *	factory ()
static void	registerContentTypePrinter (DtSimInterfaceContentTypePrinterFcn printFcn)

Protected Attributes
std::string	myMessage
MessageCategory	myMessageCategory
int	mySeverity
std::map< std::string, std::string >	myExtra
Protected Attributes inherited from DtSimInterfaceContent
char *	myNetRep
bool	myUseSessionId

Additional Inherited Members
Protected Member Functions inherited from DtSimInterfaceContent
	DtSimInterfaceContent ()
	DtSimInterfaceContent (const DtSimInterfaceContent &orig)
const DtSimInterfaceContent &	operator= (const DtSimInterfaceContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtSimInterfaceContent
static DtInterfaceContentFactory *	myFactory
static DtSimInterfaceContentTypePrinterFcn	theContentTypePrinterFcn

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
ScenarioSave
ScenarioCheckpointSaved
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::addExtra ( const std::string &  , const std::string &    )

virtual

const std::map<std::string, std::string> DtIfServerMessage::extra ( ) const

inline

virtual std::string DtIfServerMessage::extraValue ( const std::string &  key ) 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

std::map<std::string, std::string> DtIfServerMessage::myExtra

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.tot/include/vrfmsgs/ifServerMessage.h