openDAQ
Open data acquisition platform
ProcedurePtr Class Reference

Holds a callback function without return value. More...

+ Inheritance diagram for ProcedurePtr:
+ Collaboration diagram for ProcedurePtr:

Detailed Description

Holds a callback function without return value.

Represents a callable object without return value. The openDAQ SDK uses this object when it needs to make a call back to the client.

Available factories:

// Creates a new Function object.
template <typename TFunctor>
ProcedurePtr Procedure(TFunctor value)

Example:

auto procObj = Procedure([](Int a) { std::cout << a; } );
procObj(2);

Additional Inherited Members

- Public Member Functions inherited from ObjectPtr< IProcedure >
 ObjectPtr ()
 Creates a smart pointer with no wrapped interface.
 
 ObjectPtr (std::nullptr_t)
 Creates a smart pointer with no wrapped interface.
 
 ObjectPtr (const ObjectPtr< IProcedure > &objPtr)
 Creates a smart pointer from another smart pointer. More...
 
 ObjectPtr (ObjectPtr< IProcedure > &&objPtr) noexcept
 Creates a smart pointer from another smart pointer with move semantics. More...
 
 ObjectPtr (const ObjectPtr< U > &objPtr)
 Creates a smart pointer from another smart pointer of a different interface type. More...
 
 ObjectPtr (ObjectPtr< U > &&objPtr)
 Creates a smart pointer from another smart pointer of a different interface type with move semantics. More...
 
 ObjectPtr (IProcedure *&obj)
 Creates a smart pointer from an interface pointer. More...
 
 ObjectPtr (IProcedure *&&obj)
 Creates a smart pointer from an interface pointer with move semantics. More...
 
 ObjectPtr (IWeakRef *obj)
 Creates a smart pointer from a weak reference interface pointer. More...
 
 ObjectPtr (const wchar_t *value)
 Creates a string object smart pointer from UTF16 null terminated sequence. More...
 
 ObjectPtr (ConstCharPtr value)
 Creates a string object smart pointer from UTF8 null terminated sequence. More...
 
 ObjectPtr (const U &value)
 Creates a smart pointer wrapper from value type. More...
 
virtual ~ObjectPtr ()
 Destructor. More...
 
bool equals (ObjectPtr< IBaseObject > other) const
 Compares object to another object for equality. More...
 
IProceduredetach ()
 Disassociates this smart pointer object from the interface that it represents. More...
 
void dispose () const
 Disposes all references held by the object. More...
 
void release ()
 Resets the wrapped interface to nullptr. More...
 
IProcedureaddRefAndReturn () const
 Increments the reference count and returns the interface. More...
 
 operator IProcedure * () const
 Casts the pointer to the wrapped interface. More...
 
bool assigned () const
 Checks if the smart pointer is not empty.
 
IProceduregetObject () const
 Gets the pointer to the wrapped interface. More...
 
IProcedure ** addressOf ()
 Gets the address of the pointer to the wrapped interface. More...
 
IProcedure ** operator& ()
 Gets the address of the pointer to the wrapped interface. More...
 
U * as (bool borrow=false) const
 Casts the wrapped interface to another interface. More...
 
U * asOrNull (bool borrow=false) const
 Casts the wrapped interface to another interface. More...
 
Ptr asPtr (bool borrow=false) const
 Casts the wrapped interface to another interface and wraps in a smart pointer. More...
 
Ptr asPtrOrNull (bool borrow=false) const
 Casts the wrapped interface to another interface and wraps in a smart pointer. More...
 
bool supportsInterface () const
 Checks if the wrapped interface supports another interface. More...
 
bool supportsInterface (const IntfID &id) const
 Checks if the wrapped interface supports another interface using the interface ID. More...
 
CoreType getCoreType () const
 Gets the object's CoreType. More...
 
ObjectPtr< IBaseObjectconvertTo (CoreType ct) const
 Converts the object to the specified CoreType. More...
 
SizeT getHashCode () const
 Returns hash code of the object. More...
 
ObjectPtr< IStringtoString () const
 Converts the object to the string object. More...
 
void freeze () const
 Freezes the object. More...
 
Bool isFrozen () const
 Checks if the object is frozen. More...
 
void dispatch (const ObjectPtr< IBaseObject > &params) const
 Calls the stored callback. More...
 
void dispatch () const
 Calls the stored callback without any parameters. More...
 
void execute () const
 Calls the stored callback without any parameters. More...
 
void execute (Params... params) const
 Calls the stored callback. More...
 
ObjectPtr< IBaseObjectcall (Params... params) const
 Calls the stored callback and returns the result. More...
 
bool isBorrowed () const
 Checks if the reference is borrowed. More...
 
- Static Public Member Functions inherited from ObjectPtr< IProcedure >
static InterfaceToSmartPtr< U >::SmartPtr Borrow (IProcedure *&obj)
 Borrows an interface. More...
 
static InterfaceToSmartPtr< V >::SmartPtr Borrow (U *&obj)
 Borrows an interface from the interface of another type. More...
 
static InterfaceToSmartPtr< U >::SmartPtr Adopt (IProcedure *obj)
 Adopts an interface. More...
 
static Bool Equals (const ObjectPtr< IBaseObject > &a, const ObjectPtr< IBaseObject > &b)
 Value based comparison of two objects. If both objects are nullptr, they are considered to be equal. More...
 
ProcedurePtr
Holds a callback function without return value.
Definition: procedure_ptr.h:64