All Classes Functions Variables Typedefs Friends Pages
Public Member Functions | Protected Member Functions | List of all members
Glympse::ICommon Struct Referenceabstract

The foundtation for the Glympse API object model. More...

#include <ICommon.h>

Inherited by Glympse::IAddress, Glympse::IApiStatus, Glympse::IApiStatusListener [virtual], Glympse::IArray< T >, Glympse::ICardEvent [virtual], Glympse::ICardMemberDescriptor [virtual], Glympse::ICardMemberState, Glympse::ICardMemberTicket, Glympse::ICardObject, Glympse::ICardTicket, Glympse::ICardTicketBuilder [virtual], Glympse::ICardType [virtual], Glympse::IComparable [virtual], Glympse::IComparator< T >, Glympse::IDataEvent, Glympse::IDataRow, Glympse::IDirectionsManager, Glympse::IDrawable, Glympse::IEnumeration< T >, Glympse::IEventListener [virtual], Glympse::IGroupInvite, Glympse::IHandler, Glympse::IHandoffProvider, Glympse::IHistoryManager [virtual], Glympse::IInviteViewer, Glympse::ILatLng [virtual], Glympse::ILinkedAccount, Glympse::IList< T >, Glympse::ILocationListener [virtual], Glympse::ILocationProfileBuilder, Glympse::ILocationProvider, Glympse::ILong, Glympse::IMap< K, V >, Glympse::IPersistable [virtual], Glympse::IPlaceSearchRequest, Glympse::IPlaceSearchResult, Glympse::IPlaceSearchResults, Glympse::IPoi, Glympse::IPoiBuilder, Glympse::IProximityListener [virtual], Glympse::IProximityProvider, Glympse::IRunnable, Glympse::IServerError, Glympse::ISmsListener, Glympse::ISmsProvider, Glympse::IStorageUnit, Glympse::IString, Glympse::IStringBuilder, Glympse::ITrack [virtual], Glympse::ITrackBuilder [virtual], Glympse::IUserManager, Glympse::IUserTicket, and Glympse::IXoAListener [virtual].

Public Member Functions

virtual int32 retain ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 release ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hold ()=0
 Add a reference to our object in a COM-like way.
 
virtual int32 unhold ()=0
 Release a reference to our object in a COM-like way.
 
virtual int32 hashCode ()=0
 Returns an integer hash code for this object.
 
virtual bool equals (const GCommonObj &o)=0
 Compares this instance with the specified object and indicates if they are equal. More...
 
virtual GString toString ()=0
 Returns a string containing a concise, human-readable description of this object. More...
 
virtual void attachObject (const GCommon &obj)=0
 Asociates arbitrary object with the instance.
 
virtual GCommon extractObject ()=0
 Extracts associated object or NULL if no association is established.
 

Protected Member Functions

virtual ~ICommon ()
 Destructor is protected to deny explicit object deallocation. More...
 

Detailed Description

The foundtation for the Glympse API object model.

Constructor & Destructor Documentation

virtual Glympse::ICommon::~ICommon ( )
inlineprotectedvirtual

Destructor is protected to deny explicit object deallocation.

It is virtual to prevent incorrect behavior, when the object is destroyed. It is implemented to prevent linker issues.

Member Function Documentation

virtual bool Glympse::ICommon::equals ( const GCommonObj o)
pure virtual

Compares this instance with the specified object and indicates if they are equal.

In order to be equal, o must represent the same object as this instance using a class-specific comparison. The general contract is that this comparison should be reflexive, symmetric, and transitive. Also, no object reference other than NULL is equal to NULL.

The default implementation returns true only if this == o.

Parameters
oThe object to compare this instance with.
Returns
Returns true if the specified object is equal to this object; false otherwise.

Implemented in Glympse::IString, Glympse::Common< ILong >, and Glympse::Long.

virtual GString Glympse::ICommon::toString ( )
pure virtual

Returns a string containing a concise, human-readable description of this object.

This method is not designed for efficiency, so it should only be used for debugging purposes. Avoid using it in production code.

The implementation is platform specific. You should not rely on the value returned by this method.

Implemented in Glympse::Common< ILong >, and Glympse::IStringBuilder.


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