openDAQ
Open data acquisition platform
IArgumentInfo Struct Referenceabstract

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

+ Inheritance diagram for IArgumentInfo:
+ Collaboration diagram for 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

virtual ErrCode INTERFACE_FUNC getName (IString **name)=0
 Gets the name of the argument. More...
 
virtual ErrCode INTERFACE_FUNC getType (CoreType *type)=0
 Gets the core type of the argument. More...
 
virtual ErrCode INTERFACE_FUNC getItemType (CoreType *itemType)=0
 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...
 
virtual ErrCode INTERFACE_FUNC getKeyType (CoreType *keyType)=0
 Gets the key type of dict-type Argument Info objects. The item type specifies the type of keys in dictionary arguments. 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

◆ getItemType()

virtual ErrCode INTERFACE_FUNC getItemType ( CoreType itemType)
pure virtual

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.

Parameters
[out]itemTypeThe 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()

virtual ErrCode INTERFACE_FUNC getKeyType ( CoreType keyType)
pure virtual

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

Parameters
[out]keyTypeThe key type of the dictionary argument.

◆ getName()

virtual ErrCode INTERFACE_FUNC getName ( IString **  name)
pure virtual

Gets the name of the argument.

Parameters
[out]nameThe name of the argument.

◆ getType()

virtual ErrCode INTERFACE_FUNC getType ( CoreType type)
pure virtual

Gets the core type of the argument.

Parameters
[out]typeThe 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.