openDAQ
Open data acquisition platform
ArgumentInfoPtr Class Reference

Provides the name and type of a single function/procedure argument. More...

Inherits ObjectPtr< IArgumentInfo >.

Detailed Description

Provides the name and type of a single function/procedure argument.

Usually part of a list of arguments in a Callable info object.

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

Public Member Functions

daq::StringPtr getName () const
 Gets the name of the argument. More...
 
daq::CoreType getType () const
 Gets the core type of the argument. More...
 
daq::CoreType getItemType () const
 Gets the item type of list/dict-type Argument Info objects. The item type specifies the type of values in the list or dictionary arguments. More...
 
daq::CoreType getKeyType () const
 Gets the key type of dict-type Argument Info objects. The item type specifies the type of keys in dictionary arguments. More...
 

Member Function Documentation

◆ getItemType()

daq::CoreType getItemType ( ) const
inline

Gets the item type of list/dict-type Argument Info objects. The item type specifies the type of values in the list or dictionary arguments.

Returns
The item type of the list/dictionary argument.

In list-type Argument Info, the type of each item corresponds to the item type.

In dict-type Argument Info, the type of each value in the <key, value> pairing corresponds to the item type.

◆ getKeyType()

daq::CoreType getKeyType ( ) const
inline

Gets the key type of dict-type Argument Info objects. The item type specifies the type of keys in dictionary arguments.

Returns
The key type of the dictionary argument.

◆ getName()

daq::StringPtr getName ( ) const
inline

Gets the name of the argument.

Returns
The name of the argument.

◆ getType()

daq::CoreType getType ( ) const
inline

Gets the core type of the argument.

Returns
The type of the argument.

Dictionary, List and Object types should be avoided in public function/procedure callable objects as their key, item, or base interface type cannot be determined without internal knowledge of the function/procedure.