DtLgcyLgrRecFilePdu Class Reference

Instances of DtLgcyLgrRecFilePdu are used to switch a remote logger to recording-mode and to set the file into which to store captured simulation traffic. More...

Inheritance diagram for DtLgcyLgrRecFilePdu:

Collaboration diagram for DtLgcyLgrRecFilePdu:

Public Member Functions
	DtLgcyLgrRecFilePdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	(default) constructor More...
	DtLgcyLgrRecFilePdu (const DtNetLgcyLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor (construct from network representation) More...
	DtLgcyLgrRecFilePdu (DtGlobalObjectDesignator &sender, DtGlobalObjectDesignator &receiver, const char *name, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	constructor (construct and prepare for send) More...
virtual	~DtLgcyLgrRecFilePdu ()
	destructor More...
	DtLgcyLgrRecFilePdu (const DtLgcyLgrRecFilePdu &src)
	copy constructor More...
DtLgcyLgrRecFilePdu &	operator= (const DtLgcyLgrRecFilePdu &src)
	assignment operator More...
virtual const char *	filename () const
	Get/set the name of file into which traffic will be recorded. More...
virtual void	setFilename (const char *path)
virtual DtLgcyLgrStringParams *	params () const
	Return correctly casted parameters pointer; see legacyLgrControlP.h. More...
virtual void	printData () const
	Diagnostic output. More...
Public Member Functions inherited from DtLgcyLgrControlPdu
	DtLgcyLgrControlPdu (DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER)
	(default) constructor More...
	DtLgcyLgrControlPdu (const DtNetLgcyLgrControlPdu *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	constructor (constructs from network representation) More...
virtual	~DtLgcyLgrControlPdu ()
	destructor More...
	DtLgcyLgrControlPdu (const DtLgcyLgrControlPdu &src)
	copy constructor More...
DtLgcyLgrControlPdu &	operator= (const DtLgcyLgrControlPdu &src)
	assignment operator More...
const DtGlobalObjectDesignator &	receiverId () const
	Get/set Object Identifier of intended recipient (logger). More...
virtual void	setReceiverId (const DtGlobalObjectDesignator &id)
virtual const DtGlobalObjectDesignator &	senderId () const
	Get/set Object Identifier of sender, if applicable. More...
virtual void	setSenderId (const DtGlobalObjectDesignator &id)
DtLgrCommand	lgrCommand () const
	Get message-type for proper casting to a subclass. More...
DtNetLgcyLgrControlParams *	defaultParams () const
	Data place holder. More...

Private Attributes
DtFilename	myFilename
	Parameter. More...

Additional Inherited Members
Static Public Member Functions inherited from DtLgcyLgrControlPdu
static DtPdu *	create (const DtNetPacket *initial, DtBufferPtr buffer=DtUSE_INTERNAL_BUFFER, DtPduFactory *pduFactory=0)
	Create a PDU representation from a network packet. More...
static DtLgcyLgrControlPdu *	create (DtLgrCommand command)
	Create a PDU from DtLgrCommand. More...
static const char *	lgrModeEnum2string (DtLgcyLgrMode md)
	The name (as a string) of a 'DtLgcyLgrMode'-type enum (from value) More...
static const char *	lgrFilePosEnum2string (DtLgcyLgrFilePosition pos)
	The name (as a string) of a 'DtLgcyLgrFilePosition'-type enum (from value) More...
static const char *	lgrStateFlag2string (DtLgcyLgrCtrlFlagStates flg)
	The name (as a string) of a 'DtLgcyLgrCtrlFlagStates'-type enum (from value) More...
Protected Member Functions inherited from DtLgcyLgrControlPdu
DtPduKind	internalGetPduKind () const
	Identity for use by toolkit. More...
void	setLgrCommand (DtLgrCommand com)
	Set is done by constructing the proper subclass. More...

Detailed Description

Instances of DtLgcyLgrRecFilePdu are used to switch a remote logger to recording-mode and to set the file into which to store captured simulation traffic.

Constructor & Destructor Documentation

DtLgcyLgrRecFilePdu::DtLgcyLgrRecFilePdu

(

DtBufferPtr

buffer = DtUSE_INTERNAL_BUFFER

)

(default) constructor

DtLgcyLgrRecFilePdu::DtLgcyLgrRecFilePdu	(	const DtNetLgcyLgrControlPdu *	initial,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

constructor (construct from network representation)

DtLgcyLgrRecFilePdu::DtLgcyLgrRecFilePdu	(	DtGlobalObjectDesignator &	sender,
		DtGlobalObjectDesignator &	receiver,
		const char *	name,
		DtBufferPtr	buffer = DtUSE_INTERNAL_BUFFER
	)

constructor (construct and prepare for send)

virtual DtLgcyLgrRecFilePdu::~DtLgcyLgrRecFilePdu ( )

virtual

destructor

DtLgcyLgrRecFilePdu::DtLgcyLgrRecFilePdu

(

const DtLgcyLgrRecFilePdu &

src

)

copy constructor

Member Function Documentation

virtual const char* DtLgcyLgrRecFilePdu::filename ( ) const

virtual

Get/set the name of file into which traffic will be recorded.

DtLgcyLgrRecFilePdu& DtLgcyLgrRecFilePdu::operator=

(

const DtLgcyLgrRecFilePdu &

src

)

assignment operator

virtual DtLgcyLgrStringParams* DtLgcyLgrRecFilePdu::params ( ) const

virtual

Return correctly casted parameters pointer; see legacyLgrControlP.h.

virtual void DtLgcyLgrRecFilePdu::printData ( ) const

virtual

Diagnostic output.

Reimplemented from DtLgcyLgrControlPdu.

virtual void DtLgcyLgrRecFilePdu::setFilename ( const char *  path )

virtual

Member Data Documentation

DtFilename DtLgcyLgrRecFilePdu::myFilename

private

Parameter.

---

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

• legacyLcRecFile.h