DtIfOrbatOperation Class Reference

This class will transmit orbat operations that will be handled by the orbat manager in the back-end. The response will be the DtIfOrbatResponseMessage (if one is required( with the same request id as this operations

Inheritance diagram for DtIfOrbatOperation:

Public Types
enum	Operations {   Update = 1, Remove, RequestList, MakeAllPartOfOrbat,   RemoveAllFromOrbat }
enum	Flags { IterateChildrenOnAdd = 0x00000001, AddSuperiorsToOrbat = 0x00000002, ForceAdd = 0x00000004 }

Public Member Functions
	DtIfOrbatOperation ()
	DtIfOrbatOperation (const DtIfOrbatOperation &orig)
DtIfOrbatOperation &	operator= (const DtIfOrbatOperation &orig)
virtual	~DtIfOrbatOperation ()
virtual int	type () const
virtual DtSimInterfaceContent *	clone () const
virtual void	setOperation (int)
virtual int	operation () const
virtual void	addOrbatData (const DtRwOrbatData &)
virtual void	setOrbatData (const DtOrbatDataList &)
virtual const DtOrbatDataList &	orbatData () const
virtual void	setRequestId (int)
virtual int	requestId () const
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
virtual bool	setToNet ()
virtual void	printDataToString (DtString &str)
virtual void	setFlags (int)
virtual int	flags () const
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
DtU32	myRequestId
DtU32	myOperation
DtOrbatDataList	myOrbatData
DtU32	myFlags
DtU32	myUncompressedSize
DtU32	myCompressedSize
bool	myCompressed
const char *	myCompressedBuffer
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

Member Enumeration Documentation

enum DtIfOrbatOperation::Operations

Enumerator
Update
Remove	Will add or update if UUID is one that already exists in the orbat.
RequestList
MakeAllPartOfOrbat
RemoveAllFromOrbat

enum DtIfOrbatOperation::Flags

Enumerator
IterateChildrenOnAdd
AddSuperiorsToOrbat	Default is on.
ForceAdd	Default is on.

Constructor & Destructor Documentation

DtIfOrbatOperation::DtIfOrbatOperation

(

)

default constructor

DtIfOrbatOperation::DtIfOrbatOperation

(

const DtIfOrbatOperation &

orig

)

copy constructor

virtual DtIfOrbatOperation::~DtIfOrbatOperation ( )

virtual

Member Function Documentation

DtIfOrbatOperation& DtIfOrbatOperation::operator=

(

const DtIfOrbatOperation &

orig

)

assignment operator

virtual int DtIfOrbatOperation::type ( ) const

virtual

Implements DtSimInterfaceContent.

virtual DtSimInterfaceContent* DtIfOrbatOperation::clone ( ) const

virtual

Implements DtSimInterfaceContent.

virtual void DtIfOrbatOperation::setOperation ( int  )

virtual

The operation to perform on the scripted task.

virtual int DtIfOrbatOperation::operation ( ) const

virtual

virtual void DtIfOrbatOperation::addOrbatData ( const DtRwOrbatData &  )

virtual

virtual void DtIfOrbatOperation::setOrbatData ( const DtOrbatDataList &  )

virtual

virtual const DtOrbatDataList& DtIfOrbatOperation::orbatData ( ) const

virtual

virtual void DtIfOrbatOperation::setRequestId ( int  )

virtual

The request id for this operation.

virtual int DtIfOrbatOperation::requestId ( ) const

virtual

virtual int DtIfOrbatOperation::netRepSize ( ) const

virtual

Reimplemented from DtSimInterfaceContent.

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

virtual

Reimplemented from DtSimInterfaceContent.

virtual bool DtIfOrbatOperation::setToNet ( )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfOrbatOperation::printDataToString ( DtString &  str )

virtual

Reimplemented from DtSimInterfaceContent.

virtual void DtIfOrbatOperation::setFlags ( int  )

virtual

virtual int DtIfOrbatOperation::flags ( ) const

virtual

static DtSimInterfaceContent* DtIfOrbatOperation::creator ( )

static

Member Data Documentation

DtU32 DtIfOrbatOperation::myRequestId

protected

DtU32 DtIfOrbatOperation::myOperation

protected

DtOrbatDataList DtIfOrbatOperation::myOrbatData

protected

DtU32 DtIfOrbatOperation::myFlags

protected

DtU32 DtIfOrbatOperation::myUncompressedSize

mutableprotected

DtU32 DtIfOrbatOperation::myCompressedSize

mutableprotected

bool DtIfOrbatOperation::myCompressed

mutableprotected

const char* DtIfOrbatOperation::myCompressedBuffer

mutableprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-0-branch/include/vrfmsgs/ifOrbatOperation.h