| class CObjectCon : public CBase |
An object container.
An object container acts as a home for a set of related reference counting objects.
A reference counting object, a CObject type, must be added to an object container. Only one instance of a given reference counting object can be held by an object container, i.e. each object within an object container must be distinct.
Object containers are constructed by an object container index, a CObjectConIx type.
Note that this class is not intended for user derivation.
| Public Member Functions | |
|---|---|
| ~CObjectCon() | |
| IMPORT_C void | AddL(CObject *) |
| IMPORT_C CObject * | At(TInt) |
| IMPORT_C CObject * | AtL(TInt) |
| IMPORT_C TInt | CheckUniqueFullName(const CObject *, const TDesC &) |
| IMPORT_C TInt | CheckUniqueFullName(const CObject *) |
| TInt | Count() |
| IMPORT_C TInt | FindByFullName(TInt &, const TDesC &, TFullName &) |
| IMPORT_C TInt | FindByName(TInt &, const TDesC &, TName &) |
| IMPORT_C CObjectCon * | NewL() |
| IMPORT_C void | Remove(CObject *) |
| TInt | UniqueID() |
| IMPORT_C CObject * | operator[](TInt) |
| Protected Member Functions | |
|---|---|
| CObjectCon(TInt) | |
| TBool | NamesMatch(const CObject *, const CObject *) |
| TBool | NamesMatch(const CObject *, const TName &, const CObject *) |
| Public Attributes | |
|---|---|
| TInt | iUniqueID |
| Private Attributes | |
|---|---|
| TInt | iAllocated |
| TInt | iCount |
| CObject ** | iObjects |
| TAny * | iSpare1 |
| TAny * | iSpare2 |
| IMPORT_C | CObjectCon | ( | TInt | aUniqueID | ) | [protected] |
Constructor taking a unique Id.
| TInt aUniqueID | The unique Id value. |
| IMPORT_C | ~CObjectCon | ( | ) |
Destructor.
Frees all resources owned by the object container, prior to its destruction.
In particular, it destroys all contained reference counting objects.
| IMPORT_C void | AddL | ( | CObject * | anObj | ) |
Adds a reference counting object to this object container.
If the specified reference counting object has a name, it must be valid, otherwise the function leaves with KErrBadName; in addition, the reference counting object's full name must be unique to this object container, otherwise the function leaves with KErrAlreadyExists.
If the specified reference counting object has no name, then the object itself must be unique to the object container, i.e. the object container should not already contain the same reference counting object, otherwise the function leaves with KErrAlreadyExists.
| CObject * anObj | A pointer to the reference counting object to be added. |
| IMPORT_C CObject * | At | ( | TInt | aFindHandle | ) | const |
Gets a pointer to the reference counting object with the specified find-handle number.
A find-handle number is an integer which uniquely identifies a reference counting object with respect to its object container.
| TInt aFindHandle | The find-handle number of the reference counting object. The unique Id part of this number must be the same as the unique Id of this container. The index part of the find-handle number must be a valid index. |
| IMPORT_C CObject * | AtL | ( | TInt | aFindHandle | ) | const |
Gets a pointer to the reference counting object with the specified find-handle number, and leaves on error..
A find-handle number is an integer which uniquely identifies a reference counting object with respect to its object container.
| TInt aFindHandle | The find-handle number of the reference counting object. The unique Id part of this number must be the same as the unique Id of this container. The index part of the find-handle number must be a valid index. |
| IMPORT_C TInt | CheckUniqueFullName | ( | const CObject * | anOwner, |
| const TDesC & | aName | |||
| ) | const | |||
Checks that a name will be unique.
The function checks that no reference counting object exists in this object container with the same full name as that generated from the specified name and the specified owning reference counting object.
This is a useful test to ensure that the name for a potential new reference counting object will result in a unique full name.
| IMPORT_C TInt | CheckUniqueFullName | ( | const CObject * | anObject | ) | const |
Checks that the specified reference counting object does not already exist in this object container.
Uniqueness is decided by name, if the object has a name, otherwise by pointer.
If the reference counting object has a name, then it is unique only if there is no other reference counting object in the container with the same full name.
If the reference counting object has no name, then it is unique only if there is no other reference counting object in the container with the same pointer.
| const CObject * anObject | A pointer to the reference counting object to be checked. |
| TInt | Count | ( | ) | const [inline] |
Gets the number of reference counting objects in this object container.
| IMPORT_C TInt | FindByFullName | ( | TInt & | aFindHandle, |
| const TDesC & | aMatch, | |||
| TFullName & | aFullName | |||
| ) | const | |||
Searches for the reference counting object whose full name matches the specified match pattern.
The search starts at the reference counting object following the one associated with the specified find-handle number. If the specified find-handle number is zero, then searching starts at the beginning of the object container.
Notes:
1. names are folded for the purpose of pattern matching
2. if the specified find-handle number is non-zero, then the unique Id part of the number must be the same as the unique Id of this container.
| TInt & aFindHandle | On entry, contains the find-handle number of a reference counting object from where searching is to start or zero. On return, if an object is found, then this is set to the find-handle number of that object; if no object is found, then this is set to a generated number, the index part of which has the value 0x7fff. If the object container is empty, then this reference is not changed. |
| const TDesC & aMatch | The match pattern. |
| TFullName & aFullName | A modifiable buffer descriptor with a defined maximum length. On return, if an object is found, then this contains the full name of that object; if no object is found, then the length of this descriptor is set to zero. If the object container is empty, then this reference is not changed. |
| IMPORT_C TInt | FindByName | ( | TInt & | aFindHandle, |
| const TDesC & | aMatch, | |||
| TName & | aName | |||
| ) | const | |||
Searches for the reference counting object whose name matches the specified match pattern.
The search starts at the reference counting object following the one associated with the specified find-handle number. If the specified find-handle number is zero, then searching starts at the beginning of the object container.
Notes:
1. names are folded for the purpose of pattern matching
2. if the specified find-handle number is non-zero, then the unique Id part of the number must be the same as the unique Id of this container.
| TInt & aFindHandle | On entry, contains the find-handle number of a reference counting object from where searching is to start, or zero. On return, if an object is found, then this is set to the find-handle number of that object; if no object is found, then this is set to a generated number, the index part of which has the value 0x7fff. If the object container is empty, then this reference is not changed. |
| const TDesC & aMatch | The match pattern. |
| TName & aName | A modifiable buffer descriptor with a defined maximum length. On return, if an object is found, then this contains the name of that object; if no object is found, then the length of this descriptor is set to zero. If the object container is empty, then this reference is not changed. |
| TBool | NamesMatch | ( | const CObject * | anObject, |
| const CObject * | aCurrentObject | |||
| ) | const [protected] | |||
protected recursive function for use by CheckUniqueFullName
| TBool | NamesMatch | ( | const CObject * | anObject, |
| const TName & | anObjectName, | |||
| const CObject * | aCurrentObject | |||
| ) | const [protected] | |||
protected recursive function for use by CheckUniqueFullName
| IMPORT_C CObjectCon * | NewL | ( | ) | [static] |
Creates an object container.
Open code rarely, if ever, explicitly calls this function. Instead, call the CreateL() member function of the container index, CObjectConIx, which uses this function in its implementation.
| IMPORT_C void | Remove | ( | CObject * | anObj | ) |
Removes a reference counting object from this object container.
The specified reference counting object is destroyed on removal.
| CObject * anObj | A pointer to the reference counting object to be removed. |
| IMPORT_C CObject * | operator[] | ( | TInt | anIndex | ) |
Gets a pointer to the reference counting object located at the specified offset within the object container.
| TInt anIndex | The offset of the reference counting object within the object container. Offset is relative to zero. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.