GW::CORE::GInterface Class Reference

Base interface all Gateware interfaces must support at a minimum. More...

#include <GInterface.h>

Inheritance diagram for GW::CORE::GInterface:

Public Member Functions
virtual GReturn	GetCount (unsigned int &_outCount)=0
	Return the total number of active references to this object. More...
virtual GReturn	IncrementCount ()=0
	Increase the total number of active references to this object. More...
virtual GReturn	DecrementCount ()=0
	Decrease the total number of active references to this object. More...
virtual GReturn	RequestInterface (const GUUIID &_interfaceID, void **_outputInterface)=0
	Requests an interface that may or may not be supported by this object. More...

Detailed Description

Base interface all Gateware interfaces must support at a minimum.

Core features include: Interface Upgrades, Reference Counting, Event Broadcasting.

Member Function Documentation

DecrementCount()

virtual GReturn GW::CORE::GInterface::DecrementCount ( )

pure virtual

Decrease the total number of active references to this object.

Once the internal count reaches zero this object will be deallocated and your pointer will become invalid.

Return values

SUCCESS	Successfully decremented the internal reference count.
FAILURE	Decrementing of internal reference count would underflow the value.

Implemented in GW::AUDIO::GSound, GW::AUDIO::GMusic, and GW::AUDIO::GAudio.

GetCount()

virtual GReturn GW::CORE::GInterface::GetCount ( unsigned int &  _outCount )

pure virtual

Return the total number of active references to this object.

Parameters

[out]

_outCount

The total number of active references of this object.

Return values

SUCCESS	Successfully ran.
FAILURE	Either class does not exist or the internal reference count is corrupt.

Implemented in GW::AUDIO::GSound, GW::AUDIO::GMusic, and GW::AUDIO::GAudio.

IncrementCount()

virtual GReturn GW::CORE::GInterface::IncrementCount ( )

pure virtual

Increase the total number of active references to this object.

End users should only call this operation if they are familiar with reference counting behavior.

Return values

SUCCESS	Successfully incremented the internal reference count.
FAILURE	Incrementation of internal reference count would overflow the value.

Implemented in GW::AUDIO::GSound, GW::AUDIO::GMusic, and GW::AUDIO::GAudio.

RequestInterface()

virtual GReturn GW::CORE::GInterface::RequestInterface ( const GUUIID &  _interfaceID, void **  _outputInterface  )

pure virtual

Requests an interface that may or may not be supported by this object.

Can be used by the end-user to query for a new interface using the unique ID of the interface they want and implement an interface update.

Parameters

[in]	_interfaceID	The GUUIID of the interface you are requesting.
[out]	_outputInterface	Where the interface will be stored if function is successful.

Return values

SUCCESS	The interface is supported and function succeded.
INTERFACE_UNSUPPORTED	The requested interface is not supported.

Implemented in GW::AUDIO::GSound, GW::AUDIO::GMusic, and GW::AUDIO::GAudio.

---

The documentation for this class was generated from the following file:

• G_Core/GInterface.h