DtAdminLogObjectConsoleToFile Class Reference

Admin content which indicates that a VRF Object should start logging the output of its object console to the specified file. More...

Inheritance diagram for DtAdminLogObjectConsoleToFile:

Public Member Functions
	DtAdminLogObjectConsoleToFile ()
	default constructor
	DtAdminLogObjectConsoleToFile (const DtAdminLogObjectConsoleToFile &orig)
	copy constructor
const DtAdminLogObjectConsoleToFile &	operator= (const DtAdminLogObjectConsoleToFile &orig)
	assignment operator; same as copy costructor.
virtual	~DtAdminLogObjectConsoleToFile ()
	destructor
virtual bool	init ()
	Call after construction.
virtual const DtAdminContentMessageType &	type () const
virtual DtAdminContent *	clone () const
	Make a copy of this content.
virtual DtString	stringRep () const
	Get a readable string representation of this content.
virtual int	netRepSize () const
virtual bool	setFromNet (const char *contentBuffer, unsigned contentSize)
	Decodes content from buffer.
virtual bool	setToNet ()
	Encodes content into buffer.
virtual void	setLogFilename (const DtString &filename)
	The filename to which the object console will be logged.
virtual DtString	logFilename () const
	The filename to which the object console will be logged.
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
	destructor
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
	Creator function. Returns new instance of this class.
Static Public Member Functions inherited from DtAdminContent
static void	addAdminContentCreatorFcn (const DtString &contentName, DtAdminContentCreatorFcn fcn)
static void	setFactory (DtAdminContentFactory *factory)
static DtAdminContentFactory *	factory ()
static bool	isTypeRegistered (DtString type)

Protected Attributes
DtString	myLogFilename
Protected Attributes inherited from DtAdminContent
char *	myNetRep

Additional Inherited Members
Protected Member Functions inherited from DtAdminContent
	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 ()
Static Protected Attributes inherited from DtAdminContent
static DtAdminContentFactory *	myFactory

Detailed Description

Admin content which indicates that a VRF Object should start logging the output of its object console to the specified file.

Constructor & Destructor Documentation

DtAdminLogObjectConsoleToFile::DtAdminLogObjectConsoleToFile

(

)

default constructor

DtAdminLogObjectConsoleToFile::DtAdminLogObjectConsoleToFile

(

const DtAdminLogObjectConsoleToFile &

orig

)

copy constructor

virtual DtAdminLogObjectConsoleToFile::~DtAdminLogObjectConsoleToFile ( )

virtual

destructor

Member Function Documentation

const DtAdminLogObjectConsoleToFile& DtAdminLogObjectConsoleToFile::operator=

(

const DtAdminLogObjectConsoleToFile &

orig

)

assignment operator; same as copy costructor.

static DtAdminContent* DtAdminLogObjectConsoleToFile::create ( )

static

Creator function. Returns new instance of this class.

virtual bool DtAdminLogObjectConsoleToFile::init ( )

virtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtAdminLogObjectConsoleToFile::type ( ) const

virtual

Returns

Implements DtAdminContent.

virtual void DtAdminLogObjectConsoleToFile::setLogFilename ( const DtString &  filename )

virtual

The filename to which the object console will be logged.

virtual DtString DtAdminLogObjectConsoleToFile::logFilename ( ) const

virtual

The filename to which the object console will be logged.

virtual DtAdminContent* DtAdminLogObjectConsoleToFile::clone ( ) const

virtual

Make a copy of this content.

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

Implements DtAdminContent.

virtual DtString DtAdminLogObjectConsoleToFile::stringRep ( ) const

virtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtAdminLogObjectConsoleToFile::netRepSize ( ) const

virtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

virtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtAdminLogObjectConsoleToFile::setToNet ( )

virtual

Encodes content into buffer.

Reimplemented from DtAdminContent.

Member Data Documentation

DtString DtAdminLogObjectConsoleToFile::myLogFilename

protected

---

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

• /exports/nfedora7-1/nightly/docs/vrforcesDevelopment.vrf4-3-branch/include/vrftasks/adminLogObjectConsoleToFile.h