MAKLogger::DtLgrRemoteFileWriter Class Reference

Collaboration diagram for MAKLogger::DtLgrRemoteFileWriter:

Public Member Functions
	DtLgrRemoteFileWriter (DtFilename &xmlFile, DtLgrRemoteMainWindow *window, DtString *description=0, bool constructFilename=true)
	CTOR. Set constructFilename appropriately when writing. More...
virtual	~DtLgrRemoteFileWriter ()
	DTOR. More...
virtual void	writeToFile ()
	Calls writeToFile( xmlFile ) More...
virtual void	writeToFile (DtFilename &xmlFile)
	Writes to an xml file. More...
virtual int	loggerCount () const
	Get the number of loggers used when recording this file. More...
virtual bool	constructFileName () const
	Get whether the file name was constructed or explicit. More...
virtual DtString	getProtocol (int id) const
	Get the protocol for the given logger ID. More...
virtual void	setDescription (const DtString &description)
	Set a new description to be written to the file. More...
virtual DtString	description () const
	Get the description associated with the loaded remote control file. More...
virtual bool	protocolMatches (int id, DtLgrProtocol protocol) const
	Compare given protocol against protocol of given logger ID Return bool: protocols match? More...
DtEnvValueSP	setParam (const DtString &name, const DtString &val, const DtString &comment=DtString::nullString())
	Sets environment to write to the xml file. More...
DtEnvValueSP	getParam (const DtString &name) const
	Gets an attribute from the environment. More...
void	createNewRclgrFile (DtLgrRemoteMainWindow *window, const DtString &description, bool constructFilename)

Static Public Member Functions
static DtString	protocolToString (DtLgrProtocol protocolValue)
	Return a string representation of the protocol. More...

Protected Attributes
DtEnvironment	myEnvironment
DtFilename	myXmlFile
std::auto_ptr< DtEnvXMLWriter >	myXmlWriter
const DtString	myObjectType
const DtString	myLgrCountParamName
const DtString	myConstructFilenameParamName
const DtString	myDescriptionParamName

Private Member Functions
	DtLgrRemoteFileWriter (const DtLgrRemoteFileWriter &orig)
	Not implemented. More...
DtLgrRemoteFileWriter &	operator= (const DtLgrRemoteFileWriter &orig)
	Not implemented. More...

Constructor & Destructor Documentation

MAKLogger::DtLgrRemoteFileWriter::DtLgrRemoteFileWriter	(	DtFilename &	xmlFile,
		DtLgrRemoteMainWindow *	window,
		DtString *	description = 0,
		bool	constructFilename = true
	)

CTOR. Set constructFilename appropriately when writing.

virtual MAKLogger::DtLgrRemoteFileWriter::~DtLgrRemoteFileWriter ( )

virtual

DTOR.

MAKLogger::DtLgrRemoteFileWriter::DtLgrRemoteFileWriter ( const DtLgrRemoteFileWriter &  orig )

private

Not implemented.

Member Function Documentation

virtual bool MAKLogger::DtLgrRemoteFileWriter::constructFileName ( ) const

virtual

Get whether the file name was constructed or explicit.

void MAKLogger::DtLgrRemoteFileWriter::createNewRclgrFile	(	DtLgrRemoteMainWindow *	window,
		const DtString &	description,
		bool	constructFilename
	)

virtual DtString MAKLogger::DtLgrRemoteFileWriter::description ( ) const

virtual

Get the description associated with the loaded remote control file.

DtEnvValueSP MAKLogger::DtLgrRemoteFileWriter::getParam

(

const DtString &

name

)

const

Gets an attribute from the environment.

virtual DtString MAKLogger::DtLgrRemoteFileWriter::getProtocol ( int  id ) const

virtual

Get the protocol for the given logger ID.

virtual int MAKLogger::DtLgrRemoteFileWriter::loggerCount ( ) const

virtual

Get the number of loggers used when recording this file.

DtLgrRemoteFileWriter& MAKLogger::DtLgrRemoteFileWriter::operator= ( const DtLgrRemoteFileWriter &  orig )

private

Not implemented.

virtual bool MAKLogger::DtLgrRemoteFileWriter::protocolMatches ( int  id, DtLgrProtocol  protocol  ) const

virtual

Compare given protocol against protocol of given logger ID Return bool: protocols match?

static DtString MAKLogger::DtLgrRemoteFileWriter::protocolToString ( DtLgrProtocol  protocolValue )

static

Return a string representation of the protocol.

virtual void MAKLogger::DtLgrRemoteFileWriter::setDescription ( const DtString &  description )

virtual

Set a new description to be written to the file.

DtEnvValueSP MAKLogger::DtLgrRemoteFileWriter::setParam	(	const DtString &	name,
		const DtString &	val,
		const DtString &	comment = DtString::nullString()
	)

Sets environment to write to the xml file.

virtual void MAKLogger::DtLgrRemoteFileWriter::writeToFile ( )

virtual

Calls writeToFile( xmlFile )

virtual void MAKLogger::DtLgrRemoteFileWriter::writeToFile ( DtFilename &  xmlFile )

virtual

Writes to an xml file.

Member Data Documentation

const DtString MAKLogger::DtLgrRemoteFileWriter::myConstructFilenameParamName

protected

const DtString MAKLogger::DtLgrRemoteFileWriter::myDescriptionParamName

protected

DtEnvironment MAKLogger::DtLgrRemoteFileWriter::myEnvironment

protected

const DtString MAKLogger::DtLgrRemoteFileWriter::myLgrCountParamName

protected

const DtString MAKLogger::DtLgrRemoteFileWriter::myObjectType

protected

DtFilename MAKLogger::DtLgrRemoteFileWriter::myXmlFile

protected

std::auto_ptr< DtEnvXMLWriter > MAKLogger::DtLgrRemoteFileWriter::myXmlWriter

protected

---

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

• lgrRemoteFileWriter.h