DtVrfDatabaseEventParam Class Reference

Abstract base class to store the parameter for a DtVrfDatabaseEvent.

Inheritance diagram for DtVrfDatabaseEventParam:

Public Member Functions
virtual	~DtVrfDatabaseEventParam ()
DtVrfDatabaseEventParam &	operator= (const DtVrfDatabaseEventParam &)
virtual std::string	paramName (unsigned subParamIndex=0) const =0
virtual std::string	paramType (unsigned subParamIndex=0) const =0
virtual std::string	paramValueString (unsigned subParamIndex=0) const =0
virtual unsigned	numberOfSubParams () const
virtual bool	isPrimaryKey () const =0
virtual DtVrfDatabaseEventParam *	clone ()=0
	DtVrfDatabaseEventParam ()
	DtVrfDatabaseEventParam (const DtVrfDatabaseEventParam &other)

Static Public Member Functions
static void	setSqlEscapeStringFcn (std::function< std::string(std::string)> fcn)

Static Protected Member Functions
static std::string	escapeString (std::string str)

Static Protected Attributes
static std::function < std::string(std::string)>	theEscapeStrFcn

Constructor & Destructor Documentation

DtVrfDatabaseEventParam::DtVrfDatabaseEventParam

(

)

Constructor.

DtVrfDatabaseEventParam::DtVrfDatabaseEventParam

(

const DtVrfDatabaseEventParam &

other

)

Constructor.

virtual DtVrfDatabaseEventParam::~DtVrfDatabaseEventParam ( )

virtual

Destructor.

Member Function Documentation

DtVrfDatabaseEventParam& DtVrfDatabaseEventParam::operator=

(

const DtVrfDatabaseEventParam &

)

Assignment operator.

virtual std::string DtVrfDatabaseEventParam::paramName ( unsigned  subParamIndex = 0 ) const

pure virtual

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.

Implemented in DtTemplatedDatabaseEventParam< T >.

virtual std::string DtVrfDatabaseEventParam::paramType ( unsigned  subParamIndex = 0 ) const

pure virtual

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.

Implemented in DtTemplatedDatabaseEventParam< T >.

virtual std::string DtVrfDatabaseEventParam::paramValueString ( unsigned  subParamIndex = 0 ) const

pure virtual

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.

Implemented in DtTemplatedDatabaseEventParam< T >.

virtual unsigned DtVrfDatabaseEventParam::numberOfSubParams ( ) const

inlinevirtual

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 in DtTemplatedDatabaseEventParam< T >.

virtual bool DtVrfDatabaseEventParam::isPrimaryKey ( ) const

pure virtual

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

Implemented in DtTemplatedDatabaseEventParam< T >.

virtual DtVrfDatabaseEventParam* DtVrfDatabaseEventParam::clone ( )

pure virtual

Makes a new copy of this parameter.

Implemented in DtTemplatedDatabaseEventParam< T >.

static void DtVrfDatabaseEventParam::setSqlEscapeStringFcn ( std::function< std::string(std::string)>  fcn )

static

Sets a function called by sqlEscapeString to produce the escaped string. Handles SQL implementation specific escaping.

static std::string DtVrfDatabaseEventParam::escapeString ( std::string  str )

inlinestaticprotected

Creates a string that escapes characters as necessary in the given string. Default implementation simply returns the original string, but can be replaced by SQL connections using setSqlEscapeStringFcn.

Member Data Documentation

std::function<std::string(std::string)> DtVrfDatabaseEventParam::theEscapeStrFcn

staticprotected

---

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

• /data/exports/nrhent7-1/nightly/docs/vrForces.vrf5-2-branch/include/vrfMsgTransport/vrfDatabaseEventParam.h