Contains the configuration options for the database logger.

Inheritance diagram for DtRwDatabaseLoggerConfig:

Public Member Functions
	DtRwDatabaseLoggerConfig ()

	DtRwDatabaseLoggerConfig (const DtRwDatabaseLoggerConfig &orig)

DtRwDatabaseLoggerConfig &	operator= (const DtRwDatabaseLoggerConfig &orig)

virtual DtString	databaseLoggerType () const

virtual void	setDatabaseLoggerType (const DtString &t)

virtual DtString	databaseConnectionType () const

virtual void	setDatabaseConnectionType (const DtString &t)

virtual DtString	hostIP () const

virtual void	setHostIP (const DtString &a)

virtual unsigned	port () const

virtual void	setPort (unsigned p)

virtual DtString	userName () const

virtual void	setUserName (const DtString &n)

virtual DtString	password () const

virtual void	setPassword (const DtString &p)

virtual DtString	databaseName () const

virtual void	setDatabaseName (const DtString &n)

virtual DtFilename	directory () const

virtual void	setDirectory (const DtFilename &n)

virtual bool	appendPidToFilename () const

virtual void	setAppendPidToFilename (bool p)

virtual const DtNLengthIntegerVector &	enabledEventTypes () const

virtual void	setEnabledEventTypes (const DtNLengthIntegerVector &e)

virtual double	resourceThresholdPercentage () const

virtual void	setResourceThresholdPercentage (double p)

virtual double	logPeriod () const

virtual void	setLogPeriod (double p)

Public Member Functions inherited from DtReaderWriter
	DtReaderWriter ()

	DtReaderWriter (const DtString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtSymbolString &name, DtReaderWriterRegistry *parentRegistry=NULL, bool readonly=false)

	DtReaderWriter (const DtString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtSymbolString &name, const DtReaderWriter &orig, DtReaderWriterRegistry *parentRegistry=NULL)

	DtReaderWriter (const DtReaderWriter &, DtReaderWriterRegistry *parentRegistry=NULL)

const DtReaderWriter &	operator= (const DtReaderWriter &orig)

bool	operator== (const DtReaderWriter &) const

bool	operator!= (const DtReaderWriter &rhs) const

virtual	~DtReaderWriter ()

virtual void	putSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual void	postPutSelf ()

virtual void	prePutSelf ()

virtual void	getSelf (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

virtual void	postGetSelf ()

virtual void	preGetSelf ()

virtual void	writeSelf (std::string &fp, int indentLevel=0, bool writeUnspecified=false, const DtFilename &path=DtFilename::nullFilename())

virtual DtSymbolString	name () const

virtual void	addAlias (const DtSymbolString &alias)

virtual void	addAlias (const DtString &alias)

virtual bool	hasAlias (const DtSymbolString &alias)

virtual const aliasContainer &	aliases () const

virtual void	setReadonly (bool flag)

bool	isReadonly () const

virtual void	reset ()

virtual int	alignment () const

virtual bool	variableIsBound () const

virtual void	unbindVariable ()

virtual void	setName (const DtString &)

virtual const char *	readerWriterType () const

virtual const char *	xmlType () const

virtual DtString	prettyPrint () const

std::string	debugText () const

virtual void	bindVariables (DtVariableBindingsList variableBindings)

virtual std::list < DtVariableNameType >	unboundVariables () const

bool	invalid () const

virtual bool	hasChild (const DtReaderWriter *p) const

virtual bool	hasVariableReference () const

virtual void	bindLocalVariables (const DtVariableBindingsList &variableBindings)

virtual void	recordUpdateTime () const

virtual bool	changedSinceLastChecked ()

virtual bool	peekChangedSinceLastChecked () const

virtual void	putData (std::string &fp, int indentLevel=0)

virtual DtlObjPtr	getData (DtlObjPtr args, const SearchPaths &searchPaths, const DtVariableBindingsList &variableBindings)

virtual void	setValueSpecified (bool specified, bool recurse=false)

virtual bool	valueSpecified () const

virtual bool	isVariableReference () const

virtual void	setIsVariableReference (bool value)

virtual void	clearAllVariableReferenceFlags ()

virtual DtSymbolString	variableName () const

virtual void	setVariableName (const DtSymbolString variableName)

virtual const DtReaderWriter *	defaultRWValue () const

virtual DtReaderWriter *	defaultRWValue ()

virtual void	setDefaultRWValue (DtReaderWriter *)

virtual bool	checkAndSetDefaultRWValue (DtlObjPtr args, const DtReaderWriter::SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &variableBindings=nullVariableReference())

const DtReaderWriterRegistry &	registry () const

DtReaderWriterRegistry &	registry ()

virtual DtPropertyInterface *	property ()

virtual const DtPropertyInterface *	property () const

virtual DtString	toXml () const

virtual DtRwVariableBindings *	generateVariableBindings () const

virtual bool	toXml (const DtFilename &) const

virtual bool	fromXml (const DtString &)

virtual bool	fromXmlFile (const DtFilename &)

virtual void	putSelf (DtEnvironmentSP, DtEnvValueSP parent) const

virtual void	putData (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	putVariableReference (DtEnvironmentSP, DtEnvValueSP value) const

virtual void	getSelf (const DtEnvironmentSP, const DtEnvValueSP root, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	getData (const DtEnvironmentSP, const DtEnvValueSP, const SearchPaths &searchPaths=SearchPaths(), const DtVariableBindingsList &bindings=DtVariableBindingsList())

virtual void	unrecognizedItem (const DtEnvironmentSP env, const DtEnvValueSP root, const SearchPaths &searchPaths, const DtVariableBindingsList &varBindings)

virtual void	getVariableReference (DtEnvironmentSP, DtEnvValueSP value)

Additional Inherited Members
Public Types inherited from DtReaderWriter
typedef std::vector < DtSymbolString >	aliasContainer

typedef std::vector < DtSymbolString >::iterator	aliasIter

typedef std::vector < DtSymbolString > ::const_iterator	aliasConstIter

typedef std::vector< DtFilename >	SearchPaths

typedef std::pair < DtSymbolString, DtString >	DtVariableNameType

typedef DtReaderWriterFactory (	DtReaderWriterFactoryCreatorFcn )()

Static Public Member Functions inherited from DtReaderWriter
static void	putIndent (std::string &fp, int indentLevel)

static const DtVariableBindingsList &	nullVariableReference ()

static void	setPostGetSelfCallback (DtGetSelfCallbackFcn fcn, void *usrData)

static void	setPrePutSelfCallback (DtPutSelfCallbackFcn fcn, void *usrData)

static void	setPutIndent (bool)

static bool	putIndent ()

static const char *	theXmlType ()

static const DtFilename &	appPath ()

static void	setFactoryCreatorFunction (DtReaderWriterFactoryCreatorFcn fcn)

static void	createReaderWriterFactory ()

static void	cleanupFactory ()

static DtReaderWriterFactory *	factory ()

static void	setOutputStream (DtOutputStream *stream)

static DtOutputStream &	outputStream ()

static DtReaderWriter *	createFromXmlFile (const DtFilename &, bool createAsProperty=false)

static DtReaderWriter *	createFromXml (const DtString &, bool createAsProperty=false)

static DtReaderWriter *	createFromEnvironment (DtEnvironmentSP, bool createAsProperty=false)

static DtString	getAttribute (DtEnvironmentSP env, const DtString &name, DtEnvValueSP root)

Protected Member Functions inherited from DtReaderWriter
virtual void	bindToRwAsVariable (const DtReaderWriter *rw)

Static Protected Attributes inherited from DtReaderWriter
static DtString	theUnspecifiedValue

static DtGetSelfCallbackInfo	thePostGetSelfCallback

static DtPutSelfCallbackInfo	thePrePutSelfCallback

static const DtVariableBindingsList	theEmptyVariableBindingsList

static bool	theCreatorFcnSet

static DtReaderWriterFactory *	theFactory

static DtReaderWriterFactoryCreatorFcn	theFactoryCreatorFcn

static bool	thePutIndent

static DtOutputStream *	theOutputStream

Constructor & Destructor Documentation

DtRwDatabaseLoggerConfig::DtRwDatabaseLoggerConfig ( )

Constructor.

DtRwDatabaseLoggerConfig::DtRwDatabaseLoggerConfig ( const DtRwDatabaseLoggerConfig & orig )

Copy constructor.

Member Function Documentation

DtRwDatabaseLoggerConfig& DtRwDatabaseLoggerConfig::operator= ( const DtRwDatabaseLoggerConfig & orig )

Assignment operator.

virtual DtString DtRwDatabaseLoggerConfig::databaseLoggerType ( ) const

inlinevirtual

Indicates the type of database logger to create.

virtual void DtRwDatabaseLoggerConfig::setDatabaseLoggerType ( const DtString & t )

inlinevirtual

virtual DtString DtRwDatabaseLoggerConfig::databaseConnectionType ( ) const

inlinevirtual

Indicates the type of database connection to create.

virtual void DtRwDatabaseLoggerConfig::setDatabaseConnectionType ( const DtString & t )

inlinevirtual

virtual DtString DtRwDatabaseLoggerConfig::hostIP ( ) const

inlinevirtual

Indicates the database server host IP address to connect to.

virtual void DtRwDatabaseLoggerConfig::setHostIP ( const DtString & a )

inlinevirtual

virtual unsigned DtRwDatabaseLoggerConfig::port ( ) const

inlinevirtual

Indicates the port of the database server to connect to.

virtual void DtRwDatabaseLoggerConfig::setPort ( unsigned p )

inlinevirtual

virtual DtString DtRwDatabaseLoggerConfig::userName ( ) const

inlinevirtual

Indicates the username to use when connecting to a database server.

virtual void DtRwDatabaseLoggerConfig::setUserName ( const DtString & n )

inlinevirtual

virtual DtString DtRwDatabaseLoggerConfig::password ( ) const

inlinevirtual

Indicates the password to use when connecting to a database server.

virtual void DtRwDatabaseLoggerConfig::setPassword ( const DtString & p )

inlinevirtual

virtual DtString DtRwDatabaseLoggerConfig::databaseName ( ) const

virtual

Indicates the name of the database to read/write to.

virtual void DtRwDatabaseLoggerConfig::setDatabaseName ( const DtString & n )

inlinevirtual

virtual DtFilename DtRwDatabaseLoggerConfig::directory ( ) const

inlinevirtual

Indicates the directory to write the database file to, if the database is implemented as a file (e.g. SQLite). Ignored when connecting to a database server.

virtual void DtRwDatabaseLoggerConfig::setDirectory ( const DtFilename & n )

inlinevirtual

virtual bool DtRwDatabaseLoggerConfig::appendPidToFilename ( ) const

inlinevirtual

Indicates that the sim engine should append its PID to the database filename, if the database is implemented as a file (e.g. SQLite). Ignored when connecting to a database server.

virtual void DtRwDatabaseLoggerConfig::setAppendPidToFilename ( bool p )

inlinevirtual

virtual const DtNLengthIntegerVector& DtRwDatabaseLoggerConfig::enabledEventTypes ( ) const

inlinevirtual

Indicates the list of enabled event types.

virtual void DtRwDatabaseLoggerConfig::setEnabledEventTypes ( const DtNLengthIntegerVector & e )

inlinevirtual

virtual double DtRwDatabaseLoggerConfig::resourceThresholdPercentage ( ) const

inlinevirtual

The percentage of full by which a resource value must change before an update is logged.

virtual void DtRwDatabaseLoggerConfig::setResourceThresholdPercentage ( double p )

inlinevirtual

virtual double DtRwDatabaseLoggerConfig::logPeriod ( ) const

inlinevirtual

Indicates how often (in seconds) events should be logged to the database. Increasing this value makes the logging more efficient, as the database can be updated in batches. However, it means the database will not be as up to date at a given time, and if sim engine is unexpectedly shutdown, there is a greater likelihood that more data will be lost. A value of 0 or less indicates that every event should be logged individually as soon as is possible. Default is 1 second.

virtual void DtRwDatabaseLoggerConfig::setLogPeriod ( double p )

inlinevirtual

Member Data Documentation

DtRwReal DtRwDatabaseLoggerConfig::myLogPeriod

protected

DtRwReal DtRwDatabaseLoggerConfig::myResourceThresholdPercentage

protected

DtRwInt DtRwDatabaseLoggerConfig::myPort

protected

DtRwString DtRwDatabaseLoggerConfig::myDatabseLoggerType

protected

DtRwString DtRwDatabaseLoggerConfig::myDatabseConnectionType

protected

DtRwString DtRwDatabaseLoggerConfig::myHostIP

protected

DtRwString DtRwDatabaseLoggerConfig::myUserName

protected

DtRwString DtRwDatabaseLoggerConfig::myPassword

protected

DtRwString DtRwDatabaseLoggerConfig::myDatabaseName

protected

DtRwString DtRwDatabaseLoggerConfig::myDirectory

protected

DtNLengthIntegerVector DtRwDatabaseLoggerConfig::myEnabledEvents

protected

DtRwBoolean DtRwDatabaseLoggerConfig::myAppendPidToFilename

protected

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

/data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-1-branch/include/vrfutil/rwDatabaseLoggerConfig.h

Protected Attributes
DtRwReal	myLogPeriod

DtRwReal	myResourceThresholdPercentage

DtRwInt	myPort

DtRwString	myDatabseLoggerType

DtRwString	myDatabseConnectionType

DtRwString	myHostIP

DtRwString	myUserName

DtRwString	myPassword

DtRwString	myDatabaseName

DtRwString	myDirectory

DtNLengthIntegerVector	myEnabledEvents

DtRwBoolean	myAppendPidToFilename

Protected Attributes inherited from DtReaderWriter
const DtSymbolString	myName

DtReaderWriterRegistry	myRegistry

DtReaderWriterRegistry *	myParentRegistry

bool	myValueSpecified

bool	myReadOnlyFlag

bool	myIsVariableReference

DtSymbolString	myVariableName

bool	myVariableIsBound

DtReaderWriter *	myDefaultValue

aliasContainer	myAliases

bool	myInvalid

bool	myChangedFlag

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation