DtAdminLogObjectConsoleToFile Class Reference

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

Inheritance diagram for DtAdminLogObjectConsoleToFile:

Public Member Functions
	DtAdminLogObjectConsoleToFile ()
	DtAdminLogObjectConsoleToFile (const DtAdminLogObjectConsoleToFile &orig)
const DtAdminLogObjectConsoleToFile &	operator= (const DtAdminLogObjectConsoleToFile &orig)
virtual	~DtAdminLogObjectConsoleToFile () 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 void	setLogFilename (const DtString &filename)
virtual DtString	logFilename () const
Public Member Functions inherited from DtAdminContent
virtual	~DtAdminContent ()
virtual char *	netRep ()

Static Public Member Functions
static DtAdminContent *	create ()
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
DtString	myLogFilename
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

Constructor & Destructor Documentation

DtAdminLogObjectConsoleToFile::DtAdminLogObjectConsoleToFile

(

)

default constructor

DtAdminLogObjectConsoleToFile::DtAdminLogObjectConsoleToFile

(

const DtAdminLogObjectConsoleToFile &

orig

)

copy constructor

virtual DtAdminLogObjectConsoleToFile::~DtAdminLogObjectConsoleToFile ( )

overridevirtual

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 ( )

overridevirtual

Call after construction.

Reimplemented from DtAdminContent.

virtual const DtAdminContentMessageType& DtAdminLogObjectConsoleToFile::type ( ) const

overridevirtual

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

overridevirtual

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

Implements DtAdminContent.

virtual DtString DtAdminLogObjectConsoleToFile::stringRep ( ) const

overridevirtual

Get a readable string representation of this content.

Implements DtAdminContent.

virtual int DtAdminLogObjectConsoleToFile::netRepSize ( ) const

overridevirtual

Returns

Size of the serialized representation of this admin content.

Reimplemented from DtAdminContent.

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

overridevirtual

Decodes content from buffer.

Reimplemented from DtAdminContent.

virtual bool DtAdminLogObjectConsoleToFile::setToNet ( )

overridevirtual

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:

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