VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
rwDatabaseLoggerConfig.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2024 MaK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 
8 
9 #pragma once
10 
11 #include "vrfutil/vrfutilDefines.h"
12 
14 #include <readerWriter/rwString.h>
15 #include <readerWriter/rwInt.h>
16 #include <readerWriter/rwReal.h>
18 #include <readerWriter/rwBoolean.h>
19 
22 {
23 public:
24 
27 
30 
33 
35  virtual DtString databaseLoggerType() const { return myDatabseLoggerType; };
36  virtual void setDatabaseLoggerType(const DtString& t) { myDatabseLoggerType = t; };
37 
39  virtual DtString databaseConnectionType() const { return myDatabseConnectionType; };
40  virtual void setDatabaseConnectionType(const DtString& t) { myDatabseConnectionType = t; };
41 
43  virtual DtString hostIP() const { return myHostIP; };
44  virtual void setHostIP(const DtString& a) { myHostIP = a; };
45 
47  virtual unsigned port() const { return myPort; };
48  virtual void setPort(unsigned p) { myPort = p; };
49 
51  virtual DtString userName() const { return myUserName; };
52  virtual void setUserName(const DtString& n) { myUserName = n; };
53 
55  virtual DtString password() const { return myPassword; };
56  virtual void setPassword(const DtString& p) { myPassword = p; };
57 
59  virtual DtString databaseName() const;
60  virtual void setDatabaseName(const DtString& n) { myDatabaseName = n; };
61 
65  virtual DtFilename directory() const { return DtFilename(myDirectory); };
66  virtual void setDirectory(const DtFilename& n) { myDatabaseName = n; };
67 
71  virtual bool appendPidToFilename() const { return myAppendPidToFilename; };
72  virtual void setAppendPidToFilename(bool p) { myAppendPidToFilename = p; };
73 
75  virtual const DtNLengthIntegerVector& enabledEventTypes() const { return myEnabledEvents; };
76  virtual void setEnabledEventTypes(const DtNLengthIntegerVector& e) { myEnabledEvents = e; };
77 
79  virtual double resourceThresholdPercentage() const { return myResourceThresholdPercentage; };
80  virtual void setResourceThresholdPercentage(double p) { myResourceThresholdPercentage = p; };
81 
89  virtual double logPeriod() const { return myLogPeriod; };
90  virtual void setLogPeriod(double p) { myLogPeriod = p; };
91 
92 protected:
93 
94  DtRwReal myLogPeriod;
106 };
107 
108 bool DT_DLL_vrfutil ReadFromFile(const DtFilename& filePath, DtRwDatabaseLoggerConfig* input,
110 bool DT_DLL_vrfutil WriteToFile(const DtFilename& filePath, DtRwDatabaseLoggerConfig* input);
Description: DtNLengthIntegerVector is a named, readable/writable vector of integers of arbitrary len...
Definition: nLengthIntegerVector.h:28
virtual void setLogPeriod(double p)
Definition: rwDatabaseLoggerConfig.h:90
virtual DtFilename directory() const
Indicates the directory to write the database file to, if the database is implemented as a file (e...
Definition: rwDatabaseLoggerConfig.h:65
DtRwReal myResourceThresholdPercentage
Definition: rwDatabaseLoggerConfig.h:95
DtNLengthIntegerVector myEnabledEvents
Definition: rwDatabaseLoggerConfig.h:104
virtual double resourceThresholdPercentage() const
The percentage of full by which a resource value must change before an update is logged.
Definition: rwDatabaseLoggerConfig.h:79
virtual unsigned port() const
Indicates the port of the database server to connect to.
Definition: rwDatabaseLoggerConfig.h:47
virtual void setPort(unsigned p)
Definition: rwDatabaseLoggerConfig.h:48
virtual void setEnabledEventTypes(const DtNLengthIntegerVector &e)
Definition: rwDatabaseLoggerConfig.h:76
bool DT_DLL_vrfutil ReadFromFile(const DtFilename &filePath, DtRwDatabaseLoggerConfig *input, const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference())
virtual DtString userName() const
Indicates the username to use when connecting to a database server.
Definition: rwDatabaseLoggerConfig.h:51
DtRwString myPassword
Definition: rwDatabaseLoggerConfig.h:101
virtual DtString password() const
Indicates the password to use when connecting to a database server.
Definition: rwDatabaseLoggerConfig.h:55
Definition: readerWriter.h:85
Description: Readable, Writable DtString Variable substitutions are done on this object when it is re...
Definition: rwString.h:20
virtual void setDatabaseLoggerType(const DtString &t)
Definition: rwDatabaseLoggerConfig.h:36
virtual DtString databaseConnectionType() const
Indicates the type of database connection to create.
Definition: rwDatabaseLoggerConfig.h:39
virtual void setUserName(const DtString &n)
Definition: rwDatabaseLoggerConfig.h:52
DtRwInt myPort
Definition: rwDatabaseLoggerConfig.h:96
Contains the configuration options for the database logger.
Definition: rwDatabaseLoggerConfig.h:21
bool DT_DLL_vrfutil WriteToFile(const DtFilename &filePath, DtRwDatabaseLoggerConfig *input)
virtual void setHostIP(const DtString &a)
Definition: rwDatabaseLoggerConfig.h:44
DtRwString myDatabseConnectionType
Definition: rwDatabaseLoggerConfig.h:98
DtRwString myHostIP
Definition: rwDatabaseLoggerConfig.h:99
std::list< const DtRwVariableBindings * > DtVariableBindingsList
Definition: readerWriterRegistry.h:29
Description: Readable, Writable int.
Definition: rwInt.h:25
virtual void setDatabaseName(const DtString &n)
Definition: rwDatabaseLoggerConfig.h:60
virtual DtString databaseLoggerType() const
Indicates the type of database logger to create.
Definition: rwDatabaseLoggerConfig.h:35
static const DtVariableBindingsList & nullVariableReference()
DtRwString myDatabseLoggerType
Definition: rwDatabaseLoggerConfig.h:97
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
DtRwString myDirectory
Definition: rwDatabaseLoggerConfig.h:103
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtRwBoolean myAppendPidToFilename
Definition: rwDatabaseLoggerConfig.h:105
#define DT_DLL_vrfutil
This file is used to determine how to build Disable inconsistent dll linkage warning Visual Studio 6...
Definition: vrfutilDefines.h:34
virtual bool appendPidToFilename() const
Indicates that the sim engine should append its PID to the database filename, if the database is impl...
Definition: rwDatabaseLoggerConfig.h:71
virtual const DtNLengthIntegerVector & enabledEventTypes() const
Indicates the list of enabled event types.
Definition: rwDatabaseLoggerConfig.h:75
const DtReaderWriter & operator=(const DtReaderWriter &orig)
assignment operator
virtual double logPeriod() const
Indicates how often (in seconds) events should be logged to the database. Increasing this value makes...
Definition: rwDatabaseLoggerConfig.h:89
virtual void setResourceThresholdPercentage(double p)
Definition: rwDatabaseLoggerConfig.h:80
virtual DtString hostIP() const
Indicates the database server host IP address to connect to.
Definition: rwDatabaseLoggerConfig.h:43
DtRwString myUserName
Definition: rwDatabaseLoggerConfig.h:100
virtual void setDatabaseConnectionType(const DtString &t)
Definition: rwDatabaseLoggerConfig.h:40
virtual void setDirectory(const DtFilename &n)
Definition: rwDatabaseLoggerConfig.h:66
virtual void setPassword(const DtString &p)
Definition: rwDatabaseLoggerConfig.h:56
virtual void setAppendPidToFilename(bool p)
Definition: rwDatabaseLoggerConfig.h:72
DtRwString myDatabaseName
Definition: rwDatabaseLoggerConfig.h:102

Document ID: Generated on Tue Sep 24 19:28:17 EDT 2024 from SVN revision 269799
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)