DtRequestDiagnosticsAdmin Class Reference

Admin content for a message that requests the entity print diagnostics to the console.

Inheritance diagram for DtRequestDiagnosticsAdmin:

Public Types
enum	DiagonsticType { AllDiagnostics, SensorDiagnostics, InvalidDiagnostics = -1 }

Public Member Functions
	DtRequestDiagnosticsAdmin ()
	DtRequestDiagnosticsAdmin (const DtRequestDiagnosticsAdmin &orig)
const DtRequestDiagnosticsAdmin &	operator= (const DtRequestDiagnosticsAdmin &orig)
virtual	~DtRequestDiagnosticsAdmin () override
virtual bool	init () override
virtual const DtAdminContentMessageType &	type () const override
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
virtual bool	matchesDiagnosticType (DiagonsticType type)
virtual void	setDiagnosticType (DiagonsticType type)
virtual DiagonsticType	diagnosticType () const
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
static DiagonsticType	diagnosticTypeFromString (const DtString &typeStr)
static DtString	diagnosticStringFromType (DiagonsticType typeStr)
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
DtU32	myDiagnosticType
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 DtRequestDiagnosticsAdmin::DiagonsticType

Enumerator
AllDiagnostics
SensorDiagnostics
InvalidDiagnostics

Constructor & Destructor Documentation

DtRequestDiagnosticsAdmin::DtRequestDiagnosticsAdmin

(

)

default constructor

DtRequestDiagnosticsAdmin::DtRequestDiagnosticsAdmin

(

const DtRequestDiagnosticsAdmin &

orig

)

copy constructor

virtual DtRequestDiagnosticsAdmin::~DtRequestDiagnosticsAdmin ( )

overridevirtual

destructor

Member Function Documentation

const DtRequestDiagnosticsAdmin& DtRequestDiagnosticsAdmin::operator=

(

const DtRequestDiagnosticsAdmin &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtRequestDiagnosticsAdmin::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtRequestDiagnosticsAdmin::init ( )

overridevirtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtRequestDiagnosticsAdmin::type ( ) const

overridevirtual

Returns

DtRequestSupplyListAdminType

Implements DtAdminContent.

virtual DtAdminContent* DtRequestDiagnosticsAdmin::clone ( ) const

overridevirtual

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

Implements DtAdminContent.

virtual DtString DtRequestDiagnosticsAdmin::stringRep ( ) const

overridevirtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtRequestDiagnosticsAdmin::netRepSize ( ) const

overridevirtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

overridevirtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtRequestDiagnosticsAdmin::setToNet ( )

overridevirtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

virtual void DtRequestDiagnosticsAdmin::setDiagnosticType ( DiagonsticType  type )

virtual

Setter/Getter for Diagnostic Type.

virtual DiagonsticType DtRequestDiagnosticsAdmin::diagnosticType ( ) const

virtual

Setter/Getter for Diagnostic Type.

virtual bool DtRequestDiagnosticsAdmin::matchesDiagnosticType ( DiagonsticType  type )

virtual

Returns true if the diagnostic type for this message matches or includes the given type.

static DiagonsticType DtRequestDiagnosticsAdmin::diagnosticTypeFromString ( const DtString &  typeStr )

static

static DtString DtRequestDiagnosticsAdmin::diagnosticStringFromType ( DiagonsticType  typeStr )

static

Member Data Documentation

DtU32 DtRequestDiagnosticsAdmin::myDiagnosticType

protected

---

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

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