openDAQ
Open data acquisition platform
IInteger Struct Referenceabstract
+ Inheritance diagram for IInteger:
+ Collaboration diagram for IInteger:

Detailed Description

Represents int number as IInteger interface. Use this interface to wrap integer variable when you need to add the number to lists, dictionaries and other containers which accept IBaseObject and derived interfaces.

Available factories:

// Creates a new Integer. Throws exception if not successful.
IInteger* Integer_Create(Int value)
// Creates a new IntObject. Returns error code if not successful.
ErrCode createInteger(IInteger** obj, Int value)

Public Member Functions

virtual ErrCode INTERFACE_FUNC getValue (Int *value)=0
 Gets an int value stored in the object. More...
 
virtual ErrCode INTERFACE_FUNC equalsValue (Int value, Bool *equals)=0
 Compares stored int value to the int parameter. 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

◆ equalsValue()

virtual ErrCode INTERFACE_FUNC equalsValue ( Int  value,
Bool *  equals 
)
pure virtual

Compares stored int value to the int parameter.

Parameters
valueValue for comparison.
[out]equalsThe result of the comparison.

Call this method to directly compare the object to the value parameter.

◆ getValue()

virtual ErrCode INTERFACE_FUNC getValue ( Int *  value)
pure virtual

Gets an int value stored in the object.

Parameters
[out]valueStored int value.

Call this method to extract the int value that is stored in the object.

IInteger
Definition: integer.h:42
ErrCode
BEGIN_NAMESPACE_OPENDAQ typedef uint32_t ErrCode
Definition: common.h:60