openDAQ
Open data acquisition platform
CallableInfoPtr Class Reference

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

Inherits ObjectPtr< 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

daq::CoreType getReturnType () const
 Gets the return type of the callable function. More...
 
daq::ListPtr< daq::IArgumentInfo > getArguments () const
 Gets the list of arguments the callable function/procedure expects. More...
 
daq::Bool isConst () const
 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...
 

Member Function Documentation

◆ getArguments()

daq::ListPtr<daq::IArgumentInfo> getArguments ( ) const
inline

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

Returns
the list of arguments of type ArgumentInfo.

◆ getReturnType()

daq::CoreType getReturnType ( ) const
inline

Gets the return type of the callable function.

Returns
The return type of the callable.

◆ isConst()

daq::Bool isConst ( ) const
inline

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.

Returns
a flag indicating if the function is marked as const or not.