CObjectIx Class Reference

#include <e32base.h>

class CObjectIx : public CBase

Inherits from

CObjectIx
- CBase

Public Member Enumerations
enum	anonymous { ENoClose, ELocalHandle }

Public Member Functions
	~CObjectIx()
TInt	ActiveCount()
IMPORT_C TInt	AddL(CObject *)
IMPORT_C CObject *	At(TInt, TInt)
IMPORT_C CObject *	At(TInt)
IMPORT_C TInt	At(const CObject *)
IMPORT_C CObject *	AtL(TInt, TInt)
IMPORT_C CObject *	AtL(TInt)
IMPORT_C TInt	Count(CObject *)
TInt	Count()
IMPORT_C CObjectIx *	NewL()
IMPORT_C void	Remove(TInt)
IMPORT_C CObject *	operator[](TInt)

Protected Member Functions
	CObjectIx()

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

Generates handle numbers for reference counting objects.

This is referred to as an object index.

Adding a reference counting object to an object index is the way in which a unique handle number can be generated for that object. A handle number is the way in which an object, which is owned or managed by another thread or process can be identified.

Member Enumeration Documentation

Enum anonymous

Enumerator	Value	Description
ENoClose	KHandleNoClose	When ORd into the handle number, indicates that the reference counting object cannot be closed.
ELocalHandle	KHandleFlagLocal	When ORed into the handle number, indicates that the handle is a local handle.

Constructor & Destructor Documentation

CObjectIx ( )

IMPORT_C

CObjectIx

(

)

[protected]

Default constructor.

~CObjectIx ( )

IMPORT_C

~CObjectIx

(

)

Destructor.

Frees all resources owned by the object index, prior to its destruction. In particular, it calls Close() on all reference counting objects in the index.

Member Function Documentation

ActiveCount ( )

TInt

ActiveCount

(

)

const [inline]

Gets the current number of reference counting objects held by this object index.

Return Value: The current number.

AddL ( CObject * )

IMPORT_C TInt

AddL

(

CObject *

anObj

)

Adds the specified reference counting object into this object index and returns the handle number that represents it.

Parameters
anObj	The reference counting object to be added to this object index.

Return Value: The handle number.

At ( TInt, TInt )

IMPORT_C CObject *	At	(	TInt	aHandle,
			TInt	aUniqueID
		)

Gets a pointer to the reference counting object with the specified handle number and matching unique ID.

Parameters
aHandle	The handle number of the reference counting object.
aUniqueID	The unique ID.

Return Value: A pointer to the reference counting object. If there is no matching object, then this is NULL.

At ( TInt )

IMPORT_C CObject *

(

TInt

aHandle

)

Gets a pointer to the reference counting object with the specified handle number.

Parameters
aHandle	The handle number of the reference counting object.

Return Value: A pointer to the reference counting object. If there is no matching object, then this is NULL.

At ( const CObject * )

IMPORT_C TInt

(

const CObject *

anObject

)

const

Constructs and returns the handle number representing the specified reference counting object within this object index.

Parameters
anObject	The reference counting object.

Return Value: The handle number representing the reference counting object; KErrNotFound, if the reference counting object could not be found within the object index.

AtL ( TInt, TInt )

IMPORT_C CObject *	AtL	(	TInt	aHandle,
			TInt	aUniqueID
		)

Gets a pointer to the reference counting object with the specified handle number and matching unique ID.

Parameters
aHandle	The handle number of the reference counting object.
aUniqueID	The unique ID.

Return Value: A pointer to the reference counting object.

Leave Codes
KErrBadHandle	if there is no matching object.

AtL ( TInt )

IMPORT_C CObject *

AtL

(

TInt

aHandle

)

Gets a pointer to the reference counting object with the specified handle number.

Parameters
aHandle	The handle number of the reference counting object.

Return Value: A pointer to the reference counting object.

Leave Codes
KErrBadHandle	if there is no matching object.

Count ( CObject * )

IMPORT_C TInt

Count

(

CObject *

anObject

)

const

Gets the number of occurrences of the specified reference counting object within this object index.

Note that the same reference counting object can be added to an object index more than once.

Parameters
anObject	The reference counting object.

Return Value: The number of occurrences.

Count ( )

TInt

Count

(

)

const [inline]

Gets the number greater then the last slot number used to hold valid CObject pointer. The input argument of CObject* CObjectIx::operator[]() must be less then the number returned by this method.

Return Value: The number greater then the last used slot.

NewL ( )

IMPORT_C CObjectIx *

NewL

(

)

[static]

Creates a new object index.

Return Value: A pointer to the newly created object index.

Remove ( TInt )

IMPORT_C void

Remove

(

TInt

aHandle

)

Removes the reference counting object identified by handle number from this object index and closes it.

If the reference counting object cannot be closed, because CObjectIx::ENoClose is ORed into the handle number, then it is neither removed from the object index nor closed.

Parameters
aHandle	The handle number of the reference counting object to be removed and closed.

Panic Codes
E32USER-CBase	37 if aHandle does not represent an object known to this object index.

operator[] ( TInt )

IMPORT_C CObject *

operator[]

(

TInt

anIndex

)

Gets a pointer to a reference counting object located at the specified offset within the object index.

Parameters
anIndex	The offset of the reference counting object within the object index. Offset is relative to zero.

Return Value: A pointer to the reference counting object.

Panic Codes
E32USER-CBase	21 if the value of anIndex is negative or is greater than or equal to the total number of objects held by the index.