DtRequestBehaviorGraphAdminContent Class Reference

Admin content that is used to ask a behavior to start producing graphical output and sending it back (in a behaviorGraphAdminContent).

Admin content that is used to ask a single scripted task, or all running scripted tasks, to either 1) indicate whether they can produce graphs, or 2) 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 DtRequestBehaviorGraphAdminContent:

Public Types
enum	GraphRequestType { DtGraphCapableQuery, DtGenerateGraphRequest }

Public Member Functions
	DtRequestBehaviorGraphAdminContent ()
	DtRequestBehaviorGraphAdminContent (const DtRequestBehaviorGraphAdminContent &orig)
const DtRequestBehaviorGraphAdminContent &	operator= (const DtRequestBehaviorGraphAdminContent &orig)
virtual	~DtRequestBehaviorGraphAdminContent () override
virtual bool	init () override
virtual const DtAdminContentMessageType &	type () const override
virtual GraphRequestType	graphRequestType () const
virtual void	setGraphRequestType (const GraphRequestType requestType)
virtual bool	graphOutputEnabled () const
virtual void	setGraphOutputEnabled (bool b)
virtual DtSimTaskMessageType	taskType () const
virtual void	setTaskType (DtSimTaskMessageType taskType)
virtual DtAdminContent *	clone () const override
virtual DtString	stringRep () const override
virtual int	netRepSize () const override
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize) override
virtual bool	setToNet () override
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
GraphRequestType	myRequestType
DtSimTaskMessageType	myTaskType
bool	myGraphOutputEnabled
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 DtRequestBehaviorGraphAdminContent::GraphRequestType

Enumerator
DtGraphCapableQuery
DtGenerateGraphRequest

Constructor & Destructor Documentation

DtRequestBehaviorGraphAdminContent::DtRequestBehaviorGraphAdminContent

(

)

default constructor

DtRequestBehaviorGraphAdminContent::DtRequestBehaviorGraphAdminContent

(

const DtRequestBehaviorGraphAdminContent &

orig

)

copy constructor

virtual DtRequestBehaviorGraphAdminContent::~DtRequestBehaviorGraphAdminContent ( )

overridevirtual

destructor

Member Function Documentation

const DtRequestBehaviorGraphAdminContent& DtRequestBehaviorGraphAdminContent::operator=

(

const DtRequestBehaviorGraphAdminContent &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtRequestBehaviorGraphAdminContent::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtRequestBehaviorGraphAdminContent::init ( )

overridevirtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtRequestBehaviorGraphAdminContent::type ( ) const

overridevirtual

Returns

DtRequestBehaviorGraphAdminType

Implements DtAdminContent.

virtual GraphRequestType DtRequestBehaviorGraphAdminContent::graphRequestType ( ) const

virtual

Indicates whether this is a request to indicate whether graphing is available,

or to start/stop producing graphs. {@

virtual void DtRequestBehaviorGraphAdminContent::setGraphRequestType ( const GraphRequestType  requestType )

virtual

virtual bool DtRequestBehaviorGraphAdminContent::graphOutputEnabled ( ) const

virtual

If the request type is DtGraphCapableQuery, then this field is ignored in the message. If the query type is DtGenerateGraphRequest, this field turns on or off the production of the graph (and transmission via a response message).

virtual void DtRequestBehaviorGraphAdminContent::setGraphOutputEnabled ( bool  b )

virtual

virtual DtSimTaskMessageType DtRequestBehaviorGraphAdminContent::taskType ( ) const

virtual

Identifies which task to create the graph for. If blank, then all tasks should create graphs.

virtual void DtRequestBehaviorGraphAdminContent::setTaskType ( DtSimTaskMessageType  taskType )

virtual

virtual DtAdminContent* DtRequestBehaviorGraphAdminContent::clone ( ) const

overridevirtual

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

Implements DtAdminContent.

virtual DtString DtRequestBehaviorGraphAdminContent::stringRep ( ) const

overridevirtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtRequestBehaviorGraphAdminContent::netRepSize ( ) const

overridevirtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

overridevirtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtRequestBehaviorGraphAdminContent::setToNet ( )

overridevirtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

GraphRequestType DtRequestBehaviorGraphAdminContent::myRequestType

protected

DtSimTaskMessageType DtRequestBehaviorGraphAdminContent::myTaskType

protected

bool DtRequestBehaviorGraphAdminContent::myGraphOutputEnabled

protected

---

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

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