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(), CAlgorithmIdentifier(), CAlgorithmIdentifier(), ConstructL(), ConstructL(), EncodedParams(), NewL(), NewL(), NewLC(), NewLC(), iAlgorithmId, iEncodedParams, operator==(), ~CAlgorithmIdentifier()

Inherited from CBase:
Delete(), Extension_(), operator new()

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

Description

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

Parameters

const CAlgorithmIdentifier &aAlgorithmIdentifier The algorithm ID object to be copied.

Return value

CAlgorithmIdentifier * A pointer to the new algorithm ID object.

static IMPORT_C 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

const CAlgorithmIdentifier &aAlgorithmIdentifier The algorithm ID object to be copied.

Return value

CAlgorithmIdentifier * A pointer to the new algorithm ID object.

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

Description

Creates a new algorithm ID object.

Parameters

TAlgorithmId &aAlgorithmId The algorithm ID. const TDesC8 &aEncodedParams The encoded parameters.

Return value

CAlgorithmIdentifier * A pointer to the new algorithm ID object.

static IMPORT_C 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

TAlgorithmId &aAlgorithmId The algorithm ID. const TDesC8 &aEncodedParams The encoded parameters.

Return value

CAlgorithmIdentifier * A pointer to the new algorithm ID object.

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

TAlgorithmId &aAlgorithmId The algorithm ID.

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

Description

Second-phase constructor taking an existing algorithm identifier object.

Parameters

const CAlgorithmIdentifier &aAlgorithmIdentifier The algorithm identifier object.

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

Description

Second-phase constructor taking encoded parameters.

Parameters

const TDesC8 &aEncodedParams The encoded 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

const CAlgorithmIdentifier &aAlgorithmIdentifier The algorithm identifier object to be compared.

Return value

TBool ETrue, if this algorithm identifier object is equal to the specified algorithm identifier object; EFalse otherwise.

IMPORT_C TAlgorithmId Algorithm() const;

Description

Gets the algorithm identifier.

Return value

TAlgorithmId The algorithm identifier.

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

TPtrC8 The encoded parameters.

protected: TAlgorithmId iAlgorithmId;

Description

The algorithm ID.

protected: HBufC8 * iEncodedParams;

Description

The encoded parameters for the algorithm ID.