VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
vrfDatabaseEventParam.h
Go to the documentation of this file.
1 /*******************************************************************************
2 ** Copyright (c) 2024 MAK Technologies, Inc.
3 ** All rights reserved.
4 *******************************************************************************/
5 #pragma once
6 
9 
12 {
13 public:
14 
20 
23 
26 
32  virtual std::string paramName(unsigned subParamIndex = 0) const = 0;
33 
39  virtual std::string paramType(unsigned subParamIndex = 0) const = 0;
40 
46  virtual std::string paramValueString(unsigned subParamIndex = 0) const = 0;
47 
52  virtual unsigned numberOfSubParams() const { return 1; };
53 
55  virtual bool isPrimaryKey() const = 0;
56 
58  virtual DtVrfDatabaseEventParam* clone() = 0;
59 };
60 
62 template <typename T>
64 {
65 public:
66 
68  DtTemplatedDatabaseEventParam<T>(const DtString& name, T val, bool isPrimarykey = false);
69 
72 
75 
78 
81 
83  inline virtual DtVrfDatabaseEventParam* clone();
84 
85  //\copydoc DtVrfDatabaseEventParam::paramName()
86  inline virtual std::string paramName(unsigned subParamIndex = 0) const;
87 
88  //\copydoc DtVrfDatabaseEventParam::paramType()
89  inline virtual std::string paramType(unsigned subParamIndex = 0) const;
90 
91  //\copydoc DtVrfDatabaseEventParam::paramValueString()
92  inline virtual std::string paramValueString(unsigned subParamIndex = 0) const;
93 
95  inline virtual T paramValue() const;
96 
97  //\copydoc DtVrfDatabaseEventParam::numberOfSubParams()
98  inline virtual unsigned numberOfSubParams() const;
99 
100  //\copydoc DtVrfDatabaseEventParam::isPrimaryKey()
101  inline virtual bool isPrimaryKey() const;
102 
103 protected:
105  T myVal;
107 };
108 
109 
110 #include <vrfMsgTransport/vrfDatabaseEventParam.inl>
DtString myName
Definition: vrfDatabaseEventParam.h:104
DtVrfDatabaseEventParam & operator=(const DtVrfDatabaseEventParam &)
Assignment operator.
Definition: vrfDatabaseEventParam.h:25
Stores the parameter for a DtVrfDatabaseEvent.
Definition: vrfDatabaseEventParam.h:63
virtual std::string paramName(unsigned subParamIndex=0) const
Returns the name of the parameter. The subParamIndex is not necessary for most parameters, but some params end up translating into multiple parameters in the database. If numberOfSubParams() returns a value greater than 0, then specifying this will return the name of that specific sub-parameter.
virtual ~DtVrfDatabaseEventParam()
Destructor.
Definition: vrfDatabaseEventParam.h:22
virtual T paramValue() const
The stored value for this parameter.
virtual std::string paramType(unsigned subParamIndex=0) const
Returns the string of the type of this parameter. The subParamIndex is not necessary for most paramet...
virtual bool isPrimaryKey() const
Returns true if this parameter is the primary key of the table.
DtVrfDatabaseEventParam()
Constructor.
Definition: vrfDatabaseEventParam.h:17
Abstract base class to store the parameter for a DtVrfDatabaseEvent.
Definition: vrfDatabaseEventParam.h:11
virtual DtVrfDatabaseEventParam * clone()
Makes a new copy of this parameter.
T myVal
Definition: vrfDatabaseEventParam.h:105
virtual unsigned numberOfSubParams() const
For most parameters, this is just one, as there is one DtVrfDatabaseEventParam per database parameter...
Definition: vrfDatabaseEventParam.h:52
DtTemplatedDatabaseEventParam< T > & operator=(const DtTemplatedDatabaseEventParam< T > &)
Assignment operator.
#define DT_DLL_vrfMsgTransport
This file is used to determine how to build Disable inconsistent dll linkage warning Visual Studio 6...
Definition: vrfCommunicationManagerDefines.h:26
DtVrfDatabaseEventParam(const DtVrfDatabaseEventParam &other)
Constructor.
Definition: vrfDatabaseEventParam.h:18
bool myIsPrimaryKey
Definition: vrfDatabaseEventParam.h:106
virtual unsigned numberOfSubParams() const
For most parameters, this is just one, as there is one DtVrfDatabaseEventParam per database parameter...
virtual std::string paramValueString(unsigned subParamIndex=0) const
Returns a stringified version of the value of this parameter. The subParamIndex is not necessary for ...

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)