VR-Forces Developer's Guide
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
List of all members | Public Member Functions | Protected Attributes
DtTemplatedDatabaseEventParam< T > Class Template Reference

template<typename T>
class DtTemplatedDatabaseEventParam< T >

Stores the parameter for a DtVrfDatabaseEvent.

Inheritance diagram for DtTemplatedDatabaseEventParam< T >:
Inheritance graph
[legend]

Public Member Functions

 DtTemplatedDatabaseEventParam (const DtString &name, T val, bool isPrimarykey=false)
 
 DtTemplatedDatabaseEventParam (const DtTemplatedDatabaseEventParam< T > &other)
 
 DtTemplatedDatabaseEventParam (DtTemplatedDatabaseEventParam< T > &&other)
 
virtual ~DtTemplatedDatabaseEventParam () override
 
DtTemplatedDatabaseEventParam
< T > & 
operator= (const DtTemplatedDatabaseEventParam< T > &)
 
virtual DtVrfDatabaseEventParamclone () override
 
virtual std::string paramName (unsigned subParamIndex=0) const override
 
virtual std::string paramType (unsigned subParamIndex=0) const override
 
virtual std::string paramValueString (unsigned subParamIndex=0) const override
 
virtual T paramValue () const
 
virtual unsigned numberOfSubParams () const override
 
virtual bool isPrimaryKey () const override
 
- Public Member Functions inherited from DtVrfDatabaseEventParam
virtual ~DtVrfDatabaseEventParam ()
 
DtVrfDatabaseEventParamoperator= (const DtVrfDatabaseEventParam &)
 
 DtVrfDatabaseEventParam ()
 
 DtVrfDatabaseEventParam (const DtVrfDatabaseEventParam &other)
 

Protected Attributes

DtString myName
 
myVal
 
bool myIsPrimaryKey
 

Additional Inherited Members

- Static Public Member Functions inherited from DtVrfDatabaseEventParam
static void setSqlEscapeStringFcn (std::function< std::string(std::string)> fcn)
 
- Static Protected Member Functions inherited from DtVrfDatabaseEventParam
static std::string escapeString (std::string str)
 
- Static Protected Attributes inherited from DtVrfDatabaseEventParam
static std::function
< std::string(std::string)> 
theEscapeStrFcn
 

Constructor & Destructor Documentation

template<typename T>
DtTemplatedDatabaseEventParam< T >::DtTemplatedDatabaseEventParam ( const DtString name,
val,
bool  isPrimarykey = false 
)

Constructor.

Constructor.

Constructor.

template<typename T>
virtual DtTemplatedDatabaseEventParam< T >::~DtTemplatedDatabaseEventParam ( )
overridevirtual

Destructor.

Member Function Documentation

template<typename T>
DtTemplatedDatabaseEventParam<T>& DtTemplatedDatabaseEventParam< T >::operator= ( const DtTemplatedDatabaseEventParam< T > &  )

Assignment operator.

template<typename T>
virtual DtVrfDatabaseEventParam* DtTemplatedDatabaseEventParam< T >::clone ( )
inlineoverridevirtual

Makes a new copy of this parameter.

Implements DtVrfDatabaseEventParam.

template<typename T>
virtual std::string DtTemplatedDatabaseEventParam< T >::paramName ( unsigned  subParamIndex = 0) const
inlineoverridevirtual

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.

Implements DtVrfDatabaseEventParam.

template<typename T>
virtual std::string DtTemplatedDatabaseEventParam< T >::paramType ( unsigned  subParamIndex = 0) const
inlineoverridevirtual

Returns the string of the type of this 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 type of that specific sub-parameter.

Implements DtVrfDatabaseEventParam.

template<typename T>
virtual std::string DtTemplatedDatabaseEventParam< T >::paramValueString ( unsigned  subParamIndex = 0) const
inlineoverridevirtual

Returns a stringified version of the value of this 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 vale of that specific sub-parameter.

Implements DtVrfDatabaseEventParam.

template<typename T>
virtual T DtTemplatedDatabaseEventParam< T >::paramValue ( ) const
inlinevirtual

The stored value for this parameter.

template<typename T>
virtual unsigned DtTemplatedDatabaseEventParam< T >::numberOfSubParams ( ) const
inlineoverridevirtual

For most parameters, this is just one, as there is one DtVrfDatabaseEventParam per database parameter. However, some DtVrfDatabaseEventParam may translate to multiple database parameters. These event parameters are then broken into multiple sub-parameters.

Reimplemented from DtVrfDatabaseEventParam.

template<typename T>
virtual bool DtTemplatedDatabaseEventParam< T >::isPrimaryKey ( ) const
inlineoverridevirtual

Returns true if this parameter is the primary key of the table.

Implements DtVrfDatabaseEventParam.

Member Data Documentation

template<typename T>
DtString DtTemplatedDatabaseEventParam< T >::myName
protected
template<typename T>
T DtTemplatedDatabaseEventParam< T >::myVal
protected
template<typename T>
bool DtTemplatedDatabaseEventParam< T >::myIsPrimaryKey
protected

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

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)