Class CAlgorithmIdentifier

class CAlgorithmIdentifier : public CBase;

Description

Contains an algorithm ID and any encoded parameters required by that algorithm.

An object of this type creates and owns a heap descriptor to contain the encoded parameters.

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CAlgorithmIdentifier - Contains an algorithm ID and any encoded parameters required by that algorithm.

Members

Defined in CAlgorithmIdentifier:

• Algorithm()constGets the algorithm identifier.
• CAlgorithmIdentifier()Default constructor.
• CAlgorithmIdentifier(TAlgorithmId &)Constructor taking the specified parameters.
• ConstructL(const CAlgorithmIdentifier &)Second-phase constructor taking an existing algorithm identifier object.
• ConstructL(const TDesC8 &)Second-phase constructor taking encoded parameters.
• EncodedParams()constGets the encoded parameters for the algorithm identifier.
• NewL(TAlgorithmId &,const TDesC8 &)Creates a new algorithm ID object.
• NewL(const CAlgorithmIdentifier &)Creates a new algorithm ID object copied from an existing object.
• NewLC(TAlgorithmId &,const TDesC8 &)Creates a new algorithm ID object, and puts a pointer to the new object onto the...
• NewLC(const CAlgorithmIdentifier &)Creates a new algorithm ID object copied from an existing object, and puts a poi...
• iAlgorithmIdThe algorithm ID.
• iEncodedParamsThe encoded parameters for the algorithm ID.
• operator==(const CAlgorithmIdentifier &)constTests whether this algorithm identifier object is equal to the specified algorit...
• ~CAlgorithmIdentifier()Destructor.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

IMPORT_C static CAlgorithmIdentifier* NewL(const CAlgorithmIdentifier &aAlgorithmIdentifier);

Description

Creates a new algorithm ID object copied from an existing object.

Parameters

Return value

IMPORT_C static CAlgorithmIdentifier* NewLC(const CAlgorithmIdentifier &aAlgorithmIdentifier);

Description

Creates a new algorithm ID object copied from an existing object, and puts a pointer to the new object onto the cleanup stack.

Parameters

Return value

IMPORT_C static CAlgorithmIdentifier* NewL(TAlgorithmId &aAlgorithmId, const TDesC8 &aEncodedParams);

Description

Creates a new algorithm ID object.

Parameters

Return value

IMPORT_C static CAlgorithmIdentifier* NewLC(TAlgorithmId &aAlgorithmId, const TDesC8 &aEncodedParams);

Description

Creates a new algorithm ID object, and puts a pointer to the new object onto the cleanup stack.

Parameters

Return value

IMPORT_C ~CAlgorithmIdentifier();

Description

Destructor.

Frees all resources owned by the object.

protected: IMPORT_C CAlgorithmIdentifier();

Description

Default constructor.

protected: IMPORT_C CAlgorithmIdentifier(TAlgorithmId &aAlgorithmId);

Description

Constructor taking the specified parameters.

Parameters

protected: IMPORT_C virtual void ConstructL(const CAlgorithmIdentifier &aAlgorithmIdentifier);

Description

Second-phase constructor taking an existing algorithm identifier object.

Parameters

protected: IMPORT_C virtual void ConstructL(const TDesC8 &aEncodedParams);

Description

Second-phase constructor taking encoded parameters.

Parameters

IMPORT_C TBool operator==(const CAlgorithmIdentifier &aAlgorithmIdentifier) const;

Description

Tests whether this algorithm identifier object is equal to the specified algorithm identifier object.

Parameters

Return value

IMPORT_C TAlgorithmId Algorithm() const;

Description

Gets the algorithm identifier.

Return value

IMPORT_C TPtrC8 EncodedParams() const;

Description

Gets the encoded parameters for the algorithm identifier.

Note that this object owns the heap descriptor that owns the encoded parameters.

Return value

protected: TAlgorithmId iAlgorithmId;

Description

The algorithm ID.

protected: HBufC8 * iEncodedParams;

Description

The encoded parameters for the algorithm ID.