IBoolean Struct Reference

Inheritance diagram for IBoolean:

Collaboration diagram for IBoolean:

Detailed Description

Represents boolean variable as IBoolean interface. Use this interface to wrap boolean variable when you need to add the variable to lists, dictionaries and other containers which accept IBaseObject interface.

Available factories:

// Creates a new Boolean. Throws exception if not successful.
IBoolean* Boolean_Create(Bool value)
 
// Creates a new Boolean. Returns error code if not successful.
ErrCode createBoolean(IBoolean** obj, Bool value)

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

pure virtual

Compares stored boolean value to the boolean parameter.

Parameters

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

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

getValue()

virtual ErrCode INTERFACE_FUNC getValue ( Bool *  value )

pure virtual

Gets a boolean value stored in the object.

Parameters

[out]

value

Stored boolean value.

Returns

OPENDAQ_SUCCESS if succeeded, error code otherwise.

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