openDAQ
Open data acquisition platform
ICallableInfo Struct Referenceabstract

Provides information about the argument count and types, as well as the return type of Function/Procedure-type properties. More...

+ Inheritance diagram for ICallableInfo:
+ Collaboration diagram for ICallableInfo:

Detailed Description

Provides information about the argument count and types, as well as the return type of Function/Procedure-type properties.

A callable should be invoked with the parameter types specified in the arguments field, in the order listed.

A Procedure-type Property will not have a return type configured in its Callable info field.

Argument info objects implement the Struct methods internally and are Core type ctStruct.

Public Member Functions

virtual ErrCode INTERFACE_FUNC getReturnType (CoreType *type)=0
 Gets the return type of the callable function. More...
 
virtual ErrCode INTERFACE_FUNC getArguments (IList **argumentInfo)=0
 Gets the list of arguments the callable function/procedure expects. More...
 
virtual ErrCode INTERFACE_FUNC isConst (Bool *constFlag)=0
 A flag indicating if function is marked as const. A const function promises not to modify the state of the device or any other objects under the openDAQ instance. More...
 
- Public Member Functions inherited from IBaseObject
virtual ErrCode INTERFACE_FUNC borrowInterface (const IntfID &intfID, void **obj) const =0
 Returns another interface which is supported by the object without incrementing the reference count. More...
 
virtual ErrCode INTERFACE_FUNC dispose ()=0
 Disposes all references held by the object. More...
 
virtual ErrCode INTERFACE_FUNC getHashCode (SizeT *hashCode)=0
 Returns hash code of the object. More...
 
virtual ErrCode INTERFACE_FUNC equals (IBaseObject *other, Bool *equal) const =0
 Compares object to another object for equality. More...
 
virtual ErrCode INTERFACE_FUNC toString (CharPtr *str)=0
 Returns a string representation of the object. More...
 
- Public Member Functions inherited from IUnknown
virtual ErrCode INTERFACE_FUNC queryInterface (const IntfID &intfID, void **obj)=0
 Returns another interface which is supported by the object and increments the reference count. More...
 
virtual int INTERFACE_FUNC addRef ()=0
 Increments the reference count for an interface on an object. More...
 
virtual int INTERFACE_FUNC releaseRef ()=0
 Decrements the reference count for an interface on an object. More...
 

Member Function Documentation

◆ getArguments()

virtual ErrCode INTERFACE_FUNC getArguments ( IList **  argumentInfo)
pure virtual

Gets the list of arguments the callable function/procedure expects.

Parameters
[out]argumentInfothe list of arguments of type ArgumentInfo.

◆ getReturnType()

virtual ErrCode INTERFACE_FUNC getReturnType ( CoreType type)
pure virtual

Gets the return type of the callable function.

Parameters
[out]typeThe return type of the callable.

◆ isConst()

virtual ErrCode INTERFACE_FUNC isConst ( Bool *  constFlag)
pure virtual

A flag indicating if function is marked as const. A const function promises not to modify the state of the device or any other objects under the openDAQ instance.

Parameters
[out]constFlaga flag indicating if the function is marked as const or not.