QxOrm 1.4.9
C++ Object Relational Mapping library
Loading...
Searching...
No Matches

qx::IxFunction : common interface for all functions registered into QxOrm context (used by introspection engine) More...

#include <IxFunction.h>

Inheritance diagram for qx::IxFunction:
qx::QxPropertyBag qx::QxFunction_0< Owner, R > qx::QxFunction_0< void, R > qx::QxFunction_1< Owner, R, P1 > qx::QxFunction_1< void, R, P1 > qx::QxFunction_2< Owner, R, P1, P2 > qx::QxFunction_2< void, R, P1, P2 > qx::QxFunction_3< Owner, R, P1, P2, P3 > qx::QxFunction_3< void, R, P1, P2, P3 > qx::QxFunction_4< Owner, R, P1, P2, P3, P4 > qx::QxFunction_4< void, R, P1, P2, P3, P4 > qx::QxFunction_5< Owner, R, P1, P2, P3, P4, P5 > qx::QxFunction_5< void, R, P1, P2, P3, P4, P5 > qx::QxFunction_6< Owner, R, P1, P2, P3, P4, P5, P6 > qx::QxFunction_6< void, R, P1, P2, P3, P4, P5, P6 > qx::QxFunction_7< Owner, R, P1, P2, P3, P4, P5, P6, P7 > qx::QxFunction_7< void, R, P1, P2, P3, P4, P5, P6, P7 > qx::QxFunction_8< Owner, R, P1, P2, P3, P4, P5, P6, P7, P8 > qx::QxFunction_8< void, R, P1, P2, P3, P4, P5, P6, P7, P8 > qx::QxFunction_9< Owner, R, P1, P2, P3, P4, P5, P6, P7, P8, P9 > qx::QxFunction_9< void, R, P1, P2, P3, P4, P5, P6, P7, P8, P9 >

Public Types

typedef std::vector< qx::anytype_any_params
 

Public Member Functions

 IxFunction ()
 
virtual ~IxFunction ()
 
QString getKey () const
 
QString getSeparator () const
 
QString getDescription () const
 
void setKey (const QString &s)
 
void setSeparator (const QString &s)
 
void setDescription (const QString &s)
 
virtual int getParamCount () const =0
 
virtual qx_bool invoke (const QString &params=QString(), qx::any *ret=NULL) const =0
 
virtual qx_bool invoke (const type_any_params &params, qx::any *ret=NULL) const =0
 
virtual qx_bool invoke (void *pOwner, const QString &params=QString(), qx::any *ret=NULL) const =0
 
virtual qx_bool invoke (void *pOwner, const type_any_params &params, qx::any *ret=NULL) const =0
 
virtual qx_bool isValidFct () const =0
 
virtual qx_bool isValidParams (const QString &params) const =0
 
virtual qx_bool isValidParams (const type_any_params &params) const =0
 
template<class T >
qx_bool isValidOwner (void *pOwner, T *dummy) const
 
template<class T >
qx_bool isValid (const T &params) const
 
template<class T , class U >
qx_bool isValid (void *pOwner, const T &params, U *dummy) const
 
- Public Member Functions inherited from qx::QxPropertyBag
 QxPropertyBag ()
 
virtual ~QxPropertyBag ()
 
void setPropertyBag (const QString &key, const QVariant &value)
 
QVariant getPropertyBag (const QString &key) const
 
void removePropertyBag (const QString &key)
 
void clearPropertyBag ()
 
long countPropertyBag () const
 
QList< QString > getAllPropertyBagKeys () const
 

Protected Attributes

QString m_sKey
 Function key.
 
QString m_sSeparator
 Separator character(s) for 'QString' parameters type.
 
QString m_sDescription
 Function description.
 
- Protected Attributes inherited from qx::QxPropertyBag
type_hash_prop_bag_ptr m_lstPropertyBag
 List of all properties in the bag (meta-data)
 

Additional Inherited Members

- Protected Types inherited from qx::QxPropertyBag
typedef QHash< QString, QVariant > type_hash_prop_bag
 
typedef std::shared_ptr< type_hash_prop_bagtype_hash_prop_bag_ptr
 

Detailed Description

qx::IxFunction : common interface for all functions registered into QxOrm context (used by introspection engine)

Definition at line 63 of file IxFunction.h.

Member Typedef Documentation

◆ type_any_params

Definition at line 74 of file IxFunction.h.

Constructor & Destructor Documentation

◆ IxFunction()

qx::IxFunction::IxFunction ( )
inline

Definition at line 76 of file IxFunction.h.

◆ ~IxFunction()

virtual qx::IxFunction::~IxFunction ( )
inlinevirtual

Definition at line 77 of file IxFunction.h.

Member Function Documentation

◆ getDescription()

QString qx::IxFunction::getDescription ( ) const
inline

Definition at line 81 of file IxFunction.h.

◆ getKey()

QString qx::IxFunction::getKey ( ) const
inline

Definition at line 79 of file IxFunction.h.

◆ getParamCount()

◆ getSeparator()

QString qx::IxFunction::getSeparator ( ) const
inline

Definition at line 80 of file IxFunction.h.

◆ invoke() [1/4]

virtual qx_bool qx::IxFunction::invoke ( const QString & params = QString(),
qx::any * ret = NULL ) const
pure virtual

◆ invoke() [2/4]

virtual qx_bool qx::IxFunction::invoke ( const type_any_params & params,
qx::any * ret = NULL ) const
pure virtual

◆ invoke() [3/4]

virtual qx_bool qx::IxFunction::invoke ( void * pOwner,
const QString & params = QString(),
qx::any * ret = NULL ) const
pure virtual

◆ invoke() [4/4]

virtual qx_bool qx::IxFunction::invoke ( void * pOwner,
const type_any_params & params,
qx::any * ret = NULL ) const
pure virtual

◆ isValid() [1/2]

template<class T >
qx_bool qx::IxFunction::isValid ( const T & params) const
inline

Definition at line 112 of file IxFunction.h.

◆ isValid() [2/2]

template<class T , class U >
qx_bool qx::IxFunction::isValid ( void * pOwner,
const T & params,
U * dummy ) const
inline

Definition at line 120 of file IxFunction.h.

◆ isValidFct()

virtual qx_bool qx::IxFunction::isValidFct ( ) const
pure virtual

◆ isValidOwner()

template<class T >
qx_bool qx::IxFunction::isValidOwner ( void * pOwner,
T * dummy ) const
inline

Definition at line 99 of file IxFunction.h.

◆ isValidParams() [1/2]

◆ isValidParams() [2/2]

◆ setDescription()

void qx::IxFunction::setDescription ( const QString & s)
inline

Definition at line 85 of file IxFunction.h.

◆ setKey()

void qx::IxFunction::setKey ( const QString & s)
inline

Definition at line 83 of file IxFunction.h.

◆ setSeparator()

void qx::IxFunction::setSeparator ( const QString & s)
inline

Definition at line 84 of file IxFunction.h.

Member Data Documentation

◆ m_sDescription

QString qx::IxFunction::m_sDescription
protected

Function description.

Definition at line 70 of file IxFunction.h.

◆ m_sKey

QString qx::IxFunction::m_sKey
protected

Function key.

Definition at line 68 of file IxFunction.h.

◆ m_sSeparator

QString qx::IxFunction::m_sSeparator
protected

Separator character(s) for 'QString' parameters type.

Definition at line 69 of file IxFunction.h.


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