IFloat Struct Reference

Inheritance diagram for IFloat:

Collaboration diagram for IFloat:

Detailed Description

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

Float type is defined as double-precision IEEE 754 value.

Available factories:

// Creates a new Float. Throws exception if not successful.
IFloat* Float_Create(Float value)
 
// Creates a new Float. Returns error code if not successful.
ErrCode createFloat(IFloat** obj, Float value)

Public Member Functions
virtual ErrCode INTERFACE_FUNC	getValue (Float *value)=0
	Gets a float value stored in the object. More...
virtual ErrCode INTERFACE_FUNC	equalsValue (const Float value, Bool *equals)=0
	Compares stored float value to the float 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 ( const Float  value, Bool *  equals  )

pure virtual

Compares stored float value to the float parameter.

Parameters

	value	Value for comparison.
[out]	equals	The result of the comparison.

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

getValue()

virtual ErrCode INTERFACE_FUNC getValue ( Float *  value )

pure virtual

Gets a float value stored in the object.

Parameters

[out]

value

Stored float value.

Returns

OPENDAQ_SUCCESS if succeeded, error code otherwise.

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