DtAdminContent Class Reference

DtAdminContent. More...

Inheritance diagram for DtAdminContent:

List of all members.

Public Member Functions
virtual	~DtAdminContent ()
	destructor
virtual bool	init ()
	Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.
virtual int	type () const =0
virtual DtAdminContent *	clone () const =0
	Make a copy of this content.
virtual DtString	stringRep () const =0
	Get a readable string representation of this content.
virtual char *	netRep ()
Serialization Methods
These three methods must be overridden for any setRequest subclass that is going to be sent over the network and need to package their own data elements.
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Sets the contents of this set request based on the network buffer.
virtual bool	setToNet ()
	Sets netRep buffer to the contents of this set request.
Static Public Member Functions
static DtAdminContent *	createAdminContent (int requestType)
	Static functions.
static void	addAdminContentCreatorFcn (const DtString &contentName, int contentType, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	getAdminContentNameFromAdminContentType (int contentType, DtString &contentName)
static bool	getAdminContentTypeFromAdminContentName (const DtString &contentName, int &contentType)
Protected Member Functions
	DtAdminContent ()
	Constructors are protected because no one should instantiate the base class, just derived versions.
	DtAdminContent (const DtAdminContent &orig)
	copy constructor
const DtAdminContent &	operator= (const DtAdminContent &orig)
	assignment operator; same as copy costructor.
virtual char *	createNetworkBuffer ()
Protected Attributes
char *	myNetRep
Static Protected Attributes
static DtAdminContentFactory *	myFactory

---

Detailed Description

DtAdminContent.

Abstract base class for content put inside a DtAdminMessage. Derived classes contain particular content data to be transported inside the message.

Note:

Unlike tasks, sets, and reports, these classes are not reader-writer classes.

---

Constructor & Destructor Documentation

DtAdminContent::DtAdminContent

(

)

[protected]

Constructors are protected because no one should instantiate the base class, just derived versions.

default constructor

DtAdminContent::DtAdminContent

(

const DtAdminContent &

orig

)

[protected]

copy constructor

virtual DtAdminContent::~DtAdminContent

(

)

[virtual]

destructor

---

Member Function Documentation

const DtAdminContent& DtAdminContent::operator=

(

const DtAdminContent &

orig

)

[protected]

assignment operator; same as copy costructor.

virtual bool DtAdminContent::init

(

)

[virtual]

Base class init does nothing, but this will be called by create, in case any other deriving class needs to do virtual allocation.

Reimplemented in DtCurrentTasksAdminContent, DtAvailableFormationsAdmin, DtNoDataAdminContent< T_contentType >, DtUnsubscribeCurrentTasksAdminContent, DtRequestIndirectArtilleryInformation, DtAdminLogObjectConsoleToFile, DtAdminStopLoggingObjectConsoleToFile, DtRequestAvailableFormationsAdmin, DtRequestCurrentTasksAdminContent, DtRadarModesAdmin, DtRequestRadarModesAdmin, DtWeaponListRequestAdmin, and DtWeaponListResponseAdmin.

virtual int DtAdminContent::type

(

)

const [pure virtual]

Returns:

The type of admin content this class is. See types defined in msgTypes.h.

Implemented in DtCurrentTasksAdminContent, DtAvailableFormationsAdmin, DtNoDataAdminContent< T_contentType >, DtUnsubscribeCurrentTasksAdminContent, DtRequestIndirectArtilleryInformation, DtAdminLogObjectConsoleToFile, DtAdminStopLoggingObjectConsoleToFile, DtRequestAvailableFormationsAdmin, DtRequestCurrentTasksAdminContent, DtRadarModesAdmin, DtRequestRadarModesAdmin, DtWeaponListRequestAdmin, DtWeaponListResponseAdmin, BHAVE::DtAdminScriptName, BHAVE::DtIfAdminUpdateSpawnInstance, BHAVE::DtAdminRequestScriptName, BHAVE::DtIfAdminSetTemplateName, BHAVE::DtIfAdminRequestSpawnPtData, and DtSetOverlayLayerAdmin.

virtual DtAdminContent* DtAdminContent::clone

(

)

const [pure virtual]

Make a copy of this content.

Returns a pointer to a newly created copy of this class. Derived classes must override this function to create and return an instance of the derived type.

Implemented in DtCurrentTasksAdminContent, DtRadarModesAdmin, DtAvailableFormationsAdmin, DtRequestCurrentTasksAdminContent, DtWeaponListResponseAdmin, DtAdminLogObjectConsoleToFile, DtNoDataAdminContent< T_contentType >, DtUnsubscribeCurrentTasksAdminContent, DtRequestIndirectArtilleryInformation, DtAdminStopLoggingObjectConsoleToFile, DtRequestAvailableFormationsAdmin, DtRequestRadarModesAdmin, DtWeaponListRequestAdmin, BHAVE::DtAdminScriptName, BHAVE::DtIfAdminUpdateSpawnInstance, BHAVE::DtIfAdminSetTemplateName, BHAVE::DtAdminRequestScriptName, BHAVE::DtIfAdminRequestSpawnPtData, and DtSetOverlayLayerAdmin.

virtual DtString DtAdminContent::stringRep

(

)

const [pure virtual]

Get a readable string representation of this content.

Derived classes must implement this function. The string should include the identity of the content, along with any parameters. The format of the string is up to you.

Implemented in DtCurrentTasksAdminContent, DtRadarModesAdmin, DtAvailableFormationsAdmin, DtRequestCurrentTasksAdminContent, DtWeaponListResponseAdmin, DtAdminLogObjectConsoleToFile, DtNoDataAdminContent< T_contentType >, BHAVE::DtIfAdminUpdateSpawnInstance, DtUnsubscribeCurrentTasksAdminContent, DtRequestIndirectArtilleryInformation, DtAdminStopLoggingObjectConsoleToFile, DtRequestAvailableFormationsAdmin, BHAVE::DtIfAdminSetTemplateName, BHAVE::DtIfAdminRequestSpawnPtData, DtRequestRadarModesAdmin, DtWeaponListRequestAdmin, DtSetOverlayLayerAdmin, BHAVE::DtAdminScriptName, and BHAVE::DtAdminRequestScriptName.

virtual char* DtAdminContent::netRep

(

)

[virtual]

virtual int DtAdminContent::netRepSize

(

)

const [virtual]

Returns:

Size necessary for a network representation of this set request. Base class returns 0.

Reimplemented in DtCurrentTasksAdminContent, DtRadarModesAdmin, DtAvailableFormationsAdmin, DtRequestCurrentTasksAdminContent, DtWeaponListResponseAdmin, DtAdminLogObjectConsoleToFile, DtNoDataAdminContent< T_contentType >, DtUnsubscribeCurrentTasksAdminContent, DtRequestIndirectArtilleryInformation, DtAdminStopLoggingObjectConsoleToFile, DtRequestAvailableFormationsAdmin, DtRequestRadarModesAdmin, DtWeaponListRequestAdmin, BHAVE::DtAdminScriptName, BHAVE::DtIfAdminUpdateSpawnInstance, BHAVE::DtIfAdminSetTemplateName, BHAVE::DtIfAdminRequestSpawnPtData, and DtSetOverlayLayerAdmin.

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

Sets the contents of this set request based on the network buffer.

Base class does nothing and returns true.

Reimplemented in DtCurrentTasksAdminContent, DtRadarModesAdmin, DtAvailableFormationsAdmin, DtRequestCurrentTasksAdminContent, DtWeaponListResponseAdmin, DtAdminLogObjectConsoleToFile, DtNoDataAdminContent< T_contentType >, DtUnsubscribeCurrentTasksAdminContent, DtRequestIndirectArtilleryInformation, DtAdminStopLoggingObjectConsoleToFile, DtRequestAvailableFormationsAdmin, DtRequestRadarModesAdmin, DtWeaponListRequestAdmin, BHAVE::DtAdminScriptName, BHAVE::DtIfAdminUpdateSpawnInstance, BHAVE::DtIfAdminSetTemplateName, BHAVE::DtIfAdminRequestSpawnPtData, BHAVE::DtAdminRequestScriptName, and DtSetOverlayLayerAdmin.

virtual bool DtAdminContent::setToNet

(

)

[virtual]

Sets netRep buffer to the contents of this set request.

Base class does nothing and returns true.

Reimplemented in DtCurrentTasksAdminContent, DtRadarModesAdmin, DtAvailableFormationsAdmin, DtRequestCurrentTasksAdminContent, DtWeaponListResponseAdmin, DtAdminLogObjectConsoleToFile, DtNoDataAdminContent< T_contentType >, DtUnsubscribeCurrentTasksAdminContent, DtRequestIndirectArtilleryInformation, DtAdminStopLoggingObjectConsoleToFile, DtRequestAvailableFormationsAdmin, DtRequestRadarModesAdmin, DtWeaponListRequestAdmin, BHAVE::DtAdminScriptName, BHAVE::DtIfAdminUpdateSpawnInstance, BHAVE::DtIfAdminSetTemplateName, BHAVE::DtIfAdminRequestSpawnPtData, DtSetOverlayLayerAdmin, and BHAVE::DtAdminRequestScriptName.

static DtAdminContent* DtAdminContent::createAdminContent

(

int

requestType

)

[static]

Static functions.

static void DtAdminContent::addAdminContentCreatorFcn	(	const DtString &	contentName,
		int	contentType,
		DtAdminContentCreatorFcn	fcn
	)		[static]

static void DtAdminContent::setFactory

(

DtAdminContentFactory *

factory

)

[static]

static DtAdminContentFactory* DtAdminContent::factory

(

)

[static]

static bool DtAdminContent::getAdminContentNameFromAdminContentType	(	int	contentType,
		DtString &	contentName
	)		[static]

static bool DtAdminContent::getAdminContentTypeFromAdminContentName	(	const DtString &	contentName,
		int &	contentType
	)		[static]

virtual char* DtAdminContent::createNetworkBuffer

(

)

[protected, virtual]

---

Member Data Documentation

char* DtAdminContent::myNetRep [protected]

DtAdminContentFactory* DtAdminContent::myFactory [static, protected]

---

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

• include/vrftasks/adminContent.h