DtBehaviorGraphResponseAdminContent Class Reference

Admin content that is used to provide a behavior graph in response to a request.

Admin content that is used to ask a single behavior (i.e., a specific scripted task), or all behaviors, to start producing graphical output and sending it back (in a behaviorGraphAdminContent). This message is also used to end production and transmission of graph information.

Inheritance diagram for DtBehaviorGraphResponseAdminContent:

Public Types
enum	GraphResponseType { DtGraphCapableResponse, DtGraphData }

Public Member Functions
	DtBehaviorGraphResponseAdminContent ()
	DtBehaviorGraphResponseAdminContent (const DtBehaviorGraphResponseAdminContent &orig)
const DtBehaviorGraphResponseAdminContent &	operator= (const DtBehaviorGraphResponseAdminContent &orig)
virtual	~DtBehaviorGraphResponseAdminContent ()
virtual bool	init ()
virtual const DtAdminContentMessageType &	type () const
virtual const DtString &	graphResponse () const
virtual void	setGraphResponse (const DtString &str)
virtual DtAdminContent *	clone () const
virtual DtString	stringRep () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual GraphResponseType	graphResponseType () const
virtual void	setGraphResponseType (const GraphResponseType t)
virtual bool	isCapable () const
virtual void	setIsCapable (bool capable)
virtual DtSimTaskMessageType	taskType () const
virtual void	setTaskType (DtSimTaskMessageType taskType)
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
Static Public Member Functions inherited from DtAdminContent
static void	addAdminContentCreatorFcn (const DtAdminContentMessageType &contentName, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	isTypeRegistered (const DtAdminContentMessageType &type)

Protected Attributes
GraphResponseType	myResponseType
DtSimTaskMessageType	myTaskType
DtString	myGraphResponse
bool	myIsCapable
Protected Attributes inherited from DtAdminContent
char *	myNetRep

Additional Inherited Members
Protected Member Functions inherited from DtAdminContent
	DtAdminContent ()
	DtAdminContent (const DtAdminContent &orig)
const DtAdminContent &	operator= (const DtAdminContent &orig)
virtual char *	createNetworkBuffer ()
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Member Enumeration Documentation

enum DtBehaviorGraphResponseAdminContent::GraphResponseType

Enumerator
DtGraphCapableResponse
DtGraphData

Constructor & Destructor Documentation

DtBehaviorGraphResponseAdminContent::DtBehaviorGraphResponseAdminContent

(

)

default constructor

DtBehaviorGraphResponseAdminContent::DtBehaviorGraphResponseAdminContent

(

const DtBehaviorGraphResponseAdminContent &

orig

)

copy constructor

virtual DtBehaviorGraphResponseAdminContent::~DtBehaviorGraphResponseAdminContent ( )

virtual

destructor

Member Function Documentation

const DtBehaviorGraphResponseAdminContent& DtBehaviorGraphResponseAdminContent::operator=

(

const DtBehaviorGraphResponseAdminContent &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtBehaviorGraphResponseAdminContent::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtBehaviorGraphResponseAdminContent::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtBehaviorGraphResponseAdminContent::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual GraphResponseType DtBehaviorGraphResponseAdminContent::graphResponseType ( ) const

virtual

Indicates the type of response message. If this is DtGraphCapableResponse, then it indicates that the script is capable of generating graphs. In this case the isCapable field contains the response and the graphResponse string is ignored. If the type of response is DtGraphData, then the graphResponse field is used and the isCapable field is ignored.

virtual void DtBehaviorGraphResponseAdminContent::setGraphResponseType ( const GraphResponseType  t )

virtual

Indicates the type of response message. If this is DtGraphCapableResponse, then it indicates that the script is capable of generating graphs. In this case the isCapable field contains the response and the graphResponse string is ignored. If the type of response is DtGraphData, then the graphResponse field is used and the isCapable field is ignored.

virtual const DtString& DtBehaviorGraphResponseAdminContent::graphResponse ( ) const

virtual

This is the graph information. Initially, this is a file name of an html file describing the graph in svg. (TODO – put dot commands in this string.)

virtual void DtBehaviorGraphResponseAdminContent::setGraphResponse ( const DtString &  str )

virtual

virtual bool DtBehaviorGraphResponseAdminContent::isCapable ( ) const

virtual

Indicates that the give script type is capable of generating graphs.

virtual void DtBehaviorGraphResponseAdminContent::setIsCapable ( bool  capable )

virtual

Indicates that the give script type is capable of generating graphs.

virtual DtSimTaskMessageType DtBehaviorGraphResponseAdminContent::taskType ( ) const

virtual

Identifies which task that the graph is for.

virtual void DtBehaviorGraphResponseAdminContent::setTaskType ( DtSimTaskMessageType  taskType )

virtual

Identifies which task that the graph is for.

virtual DtAdminContent* DtBehaviorGraphResponseAdminContent::clone ( ) const

virtual

Indicates that.

Make a copy of this content. Returns a pointer to a newly created copy of this class.

Implements DtAdminContent.

virtual DtString DtBehaviorGraphResponseAdminContent::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtBehaviorGraphResponseAdminContent::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtBehaviorGraphResponseAdminContent::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

GraphResponseType DtBehaviorGraphResponseAdminContent::myResponseType

protected

DtSimTaskMessageType DtBehaviorGraphResponseAdminContent::myTaskType

protected

DtString DtBehaviorGraphResponseAdminContent::myGraphResponse

protected

bool DtBehaviorGraphResponseAdminContent::myIsCapable

protected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrftasks/behaviorGraphResponseAdminContent.h