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 #include <vrfutil/rwTemplatedMap.h>
20 
23 {
24 public:
25 
28 
31 
34 
36  virtual DtString databaseLoggerType() const { return myDatabseLoggerType; };
37  virtual void setDatabaseLoggerType(const DtString& t) { myDatabseLoggerType = t; };
38 
40  virtual DtString databaseConnectionType() const { return myDatabseConnectionType; };
41  virtual void setDatabaseConnectionType(const DtString& t) { myDatabseConnectionType = t; };
42 
44  virtual DtString hostIP() const { return myHostIP; };
45  virtual void setHostIP(const DtString& a) { myHostIP = a; };
46 
48  virtual unsigned port() const { return myPort; };
49  virtual void setPort(unsigned p) { myPort = p; };
50 
52  virtual DtString userName() const { return myUserName; };
53  virtual void setUserName(const DtString& n) { myUserName = n; };
54 
56  virtual DtString password() const { return myPassword; };
57  virtual void setPassword(const DtString& p) { myPassword = p; };
58 
60  virtual DtString databaseName() const;
61  virtual void setDatabaseName(const DtString& n) { myDatabaseName = n; };
62 
66  virtual DtFilename directory() const { return DtFilename(myDirectory); };
67  virtual void setDirectory(const DtFilename& n) { myDatabaseName = n; };
68 
72  virtual bool appendPidToFilename() const { return myAppendPidToFilename; };
73  virtual void setAppendPidToFilename(bool p) { myAppendPidToFilename = p; };
74 
76  virtual const DtNLengthIntegerVector& enabledEventTypes() const { return myEnabledEvents; };
77  virtual void setEnabledEventTypes(const DtNLengthIntegerVector& e) { myEnabledEvents = e; };
78 
80  virtual double resourceThresholdPercentage() const { return myResourceThresholdPercentage; };
81  virtual void setResourceThresholdPercentage(double p) { myResourceThresholdPercentage = p; };
82 
84  virtual const std::map<DtRwInt, DtRwString>& additionalEventTypes() const {
85  return myAdditionalEventTypes.convertToMap();
86  }
87  virtual void setAdditionalEventTypes(const std::map<DtRwInt, DtRwString>& eventTypes) {
88  return myAdditionalEventTypes.setFromMap(eventTypes);
89  }
90 
98  virtual double logPeriod() const { return myLogPeriod; };
99  virtual void setLogPeriod(double p) { myLogPeriod = p; };
100 
101 protected:
102 
103  DtRwReal myLogPeriod;
116 };
117 
118 bool DT_DLL_vrfutil ReadFromFile(const DtFilename& filePath, DtRwDatabaseLoggerConfig* input,
120 bool DT_DLL_vrfutil WriteToFile(const DtFilename& filePath, DtRwDatabaseLoggerConfig* input);
DtRwTemplatedMapPtr< DtRwInt, DtRwString > myAdditionalEventTypes
Definition: rwDatabaseLoggerConfig.h:115
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:99
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:66
DtRwReal myResourceThresholdPercentage
Definition: rwDatabaseLoggerConfig.h:104
std::map< DtVrfDatabaseEvent::EventType, std::string > eventTypes()
Returns the list of all default database event type to table name mappings.
Definition: vrfDefaultDatabaseEvents.h:402
bool DT_DLL_vrfutil WriteToFile(const DtFilename &filePath, DtRwChatChannelConfig *input)
bool DT_DLL_vrfutil ReadFromFile(const DtFilename &filePath, DtRwChatChannelConfig *input, const DtVariableBindingsList &variableBindings=DtReaderWriter::nullVariableReference())
DtNLengthIntegerVector myEnabledEvents
Definition: rwDatabaseLoggerConfig.h:113
virtual double resourceThresholdPercentage() const
The percentage of full by which a resource value must change before an update is logged.
Definition: rwDatabaseLoggerConfig.h:80
virtual unsigned port() const
Indicates the port of the database server to connect to.
Definition: rwDatabaseLoggerConfig.h:48
virtual void setPort(unsigned p)
Definition: rwDatabaseLoggerConfig.h:49
virtual void setEnabledEventTypes(const DtNLengthIntegerVector &e)
Definition: rwDatabaseLoggerConfig.h:77
virtual DtString userName() const
Indicates the username to use when connecting to a database server.
Definition: rwDatabaseLoggerConfig.h:52
DtRwString myPassword
Definition: rwDatabaseLoggerConfig.h:110
virtual DtString password() const
Indicates the password to use when connecting to a database server.
Definition: rwDatabaseLoggerConfig.h:56
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:37
virtual void setAdditionalEventTypes(const std::map< DtRwInt, DtRwString > &eventTypes)
Definition: rwDatabaseLoggerConfig.h:87
virtual DtString databaseConnectionType() const
Indicates the type of database connection to create.
Definition: rwDatabaseLoggerConfig.h:40
virtual void setUserName(const DtString &n)
Definition: rwDatabaseLoggerConfig.h:53
DtRwInt myPort
Definition: rwDatabaseLoggerConfig.h:105
Contains the configuration options for the database logger.
Definition: rwDatabaseLoggerConfig.h:22
virtual void setHostIP(const DtString &a)
Definition: rwDatabaseLoggerConfig.h:45
DtRwString myDatabseConnectionType
Definition: rwDatabaseLoggerConfig.h:107
DtRwString myHostIP
Definition: rwDatabaseLoggerConfig.h:108
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:61
virtual DtString databaseLoggerType() const
Indicates the type of database logger to create.
Definition: rwDatabaseLoggerConfig.h:36
static const DtVariableBindingsList & nullVariableReference()
DtRwString myDatabseLoggerType
Definition: rwDatabaseLoggerConfig.h:106
Description: Readable, Writable DtReal (double)
Definition: rwReal.h:27
DtRwString myDirectory
Definition: rwDatabaseLoggerConfig.h:112
Description: Readable, Writable bool.
Definition: rwBoolean.h:26
DtRwBoolean myAppendPidToFilename
Definition: rwDatabaseLoggerConfig.h:114
#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:72
virtual const DtNLengthIntegerVector & enabledEventTypes() const
Indicates the list of enabled event types.
Definition: rwDatabaseLoggerConfig.h:76
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:98
virtual void setResourceThresholdPercentage(double p)
Definition: rwDatabaseLoggerConfig.h:81
virtual DtString hostIP() const
Indicates the database server host IP address to connect to.
Definition: rwDatabaseLoggerConfig.h:44
DtRwString myUserName
Definition: rwDatabaseLoggerConfig.h:109
virtual void setDatabaseConnectionType(const DtString &t)
Definition: rwDatabaseLoggerConfig.h:41
virtual void setDirectory(const DtFilename &n)
Definition: rwDatabaseLoggerConfig.h:67
virtual const std::map< DtRwInt, DtRwString > & additionalEventTypes() const
Additional user defined event types and the table names they map to.
Definition: rwDatabaseLoggerConfig.h:84
virtual void setPassword(const DtString &p)
Definition: rwDatabaseLoggerConfig.h:57
virtual void setAppendPidToFilename(bool p)
Definition: rwDatabaseLoggerConfig.h:73
DtRwString myDatabaseName
Definition: rwDatabaseLoggerConfig.h:111

Document ID: Generated on Thu Oct 23 22:29:17 EDT 2025 from SVN revision 280951
Copyright © 2005-2024 MAK Technologies. All Rights Reserved (www.mak.com)