CMifareClassicSector Class Reference

#include <mw/mifareclassicsector.h>

Link against: nfctagextension.lib

class CMifareClassicSector : public CBase

Inherits from

CMifareClassicSector
- CBase

Public Member Enumerations
enum	TSectorType { E1KSector, E4KSector }

Public Member Functions
	~CMifareClassicSector()
IMPORT_C const CMifareClassicAccessBits &	AccessBits()
IMPORT_C MifareClassicCommon::TSectorTrailerAccessCondition	AccessConditionForSectorTrailer()
IMPORT_C TInt	Copy(const CMifareClassicSector &)
IMPORT_C HBufC8 *	ExportDataL()
IMPORT_C HBufC8 *	ExportDataLC()
IMPORT_C TInt	GetAccessConditionForDataBlock(TUint8, MifareClassicCommon::TDataBlockAccessCondition &)
IMPORT_C TInt	GetDataBlock(TUint8, CMifareClassicDataBlock &)
IMPORT_C TInt	ImportData(const TDesC8 &)
IMPORT_C CMifareClassicSector *	NewL(TSectorType)
IMPORT_C CMifareClassicSector *	NewL(CMifareClassicSector &)
IMPORT_C CMifareClassicSector *	NewL(const TDesC8 &)
IMPORT_C CMifareClassicSector *	NewL(const TDesC8 &, const TDesC8 &, const CMifareClassicAccessBits &, const RPointerArray< CMifareClassicDataBlock > &)
IMPORT_C CMifareClassicSector *	NewLC(TSectorType)
IMPORT_C CMifareClassicSector *	NewLC(CMifareClassicSector &)
IMPORT_C CMifareClassicSector *	NewLC(const TDesC8 &)
IMPORT_C CMifareClassicSector *	NewLC(const TDesC8 &, const TDesC8 &, const CMifareClassicAccessBits &, const RPointerArray< CMifareClassicDataBlock > &)
IMPORT_C TSectorType	SectorType()
IMPORT_C void	SetAccessBits(const CMifareClassicAccessBits &)
IMPORT_C TInt	SetAccessConditionForDataBlock(TUint8, const MifareClassicCommon::TDataBlockAccessCondition &)
IMPORT_C void	SetAccessConditionForSectorTrailer(const MifareClassicCommon::TSectorTrailerAccessCondition &)
IMPORT_C TInt	SetDataBlock(TUint8, const CMifareClassicDataBlock &)
IMPORT_C TInt	SetDataBlock(TUint8, const TDesC8 &)
IMPORT_C TInt	SetSecretKey(MifareClassicCommon::TKeyType, const TDesC8 &)
IMPORT_C TBool	operator!=(const CMifareClassicSector &)
IMPORT_C TBool	operator==(const CMifareClassicSector &)

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

This class provides easy access to Mifare classic sectors.

Member Enumeration Documentation

Enum TSectorType

Describes whether sector size is 1 or 4 kilobytes

Enumerator	Value	Description
E1KSector	1
E4KSector

Constructor & Destructor Documentation

~CMifareClassicSector ( )

IMPORT_C

~CMifareClassicSector

(

)

Destructor.

Member Function Documentation

AccessBits ( )

IMPORT_C const CMifareClassicAccessBits &

AccessBits

(

)

const

Returns reference CMifareClassicAccessBits of this CMifareClassicSector.

Return Value: Reference to access bits.

AccessConditionForSectorTrailer ( )

IMPORT_C MifareClassicCommon::TSectorTrailerAccessCondition

AccessConditionForSectorTrailer

(

)

Return access condition for sector trailer.

Return Value: Access condition for sector trailer.

Copy ( const CMifareClassicSector & )

IMPORT_C TInt

Copy

(

const CMifareClassicSector &

aSector

)

Copies data from specified CMifareClassicSector to this CMifareClassicSector by replacing any existing data.

Parameters
aSector	Sector which content is copied to this CMifareClassicSector.

ExportDataL ( )

IMPORT_C HBufC8 *

ExportDataL

(

)

const

Transforms this sector into raw data.

Return Value: Pointer to descriptor which contains raw data.

ExportDataLC ( )

IMPORT_C HBufC8 *

ExportDataLC

(

)

const

Transforms this sector into raw data.

Return Value: Pointer to descriptor which contains raw data.

GetAccessConditionForDataBlock ( TUint8, MifareClassicCommon::TDataBlockAccessCondition & )

IMPORT_C TInt	GetAccessConditionForDataBlock	(	TUint8	aBlockNumber,
			MifareClassicCommon::TDataBlockAccessCondition &	aAccessCondition
		)	const

Gets access condition for specified data block.

Parameters
aBlockNumber	Block number.
aAccessCondition	Access condition.

Return Values

KErrArgument	if block number is greater than 2.
KErrNone	if successful.

GetDataBlock ( TUint8, CMifareClassicDataBlock & )

IMPORT_C TInt	GetDataBlock	(	TUint8	aBlockNumber,
			CMifareClassicDataBlock &	aDataBlock
		)

Gets datablock.

Parameters
aBlockNumber	Block number.

Return Value: Pointer to Data block object.

ImportData ( const TDesC8 & )

IMPORT_C TInt

ImportData

(

const TDesC8 &

aData

)

Imports specified data to sector. All old data of the sector will be lost during the execution of this method. If import method fails, old data will be saved.

Parameters
aData	Descriptor for a buffer to read raw data from. Buffer must contain following attributes ( in the following order ):Secret key A ( 6 bytes )Access bits ( 4 bytes )Secret key B ( 6 bytes )DataBlock 0 ( 16 bytes )DataBlock 1 ( 16 bytes )DataBlock 2 ( 16 bytes )

Return Values

KErrArgument	If size of the buffer differ from the size of the mifare classic sector.
KErrNone	If successful.

NewL ( TSectorType )

IMPORT_C CMifareClassicSector *

NewL

(

TSectorType

aSize

)

[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aSize	Describes whether sector is 1 or 4 kilobytes.

Return Value: Pointer to the newly created instance.

NewL ( CMifareClassicSector & )

IMPORT_C CMifareClassicSector *

NewL

(

CMifareClassicSector &

aSector

)

[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aSector	Mifare classic sector which content is copied to this object.

Return Value: Pointer to the newly created instance.

NewL ( const TDesC8 & )

IMPORT_C CMifareClassicSector *

NewL

(

const TDesC8 &

aData

)

[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aData	Descriptor which content will be copied to this object.

Return Value: Pointer to the newly created instance.

NewL ( const TDesC8 &, const TDesC8 &, const CMifareClassicAccessBits &, const RPointerArray< CMifareClassicDataBlock > & )

IMPORT_C CMifareClassicSector *	NewL	(	const TDesC8 &	aKeyA,
			const TDesC8 &	aKeyB,
			const CMifareClassicAccessBits &	aAccessBits,
			const RPointerArray< CMifareClassicDataBlock > &	aBlockArray
		)	[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aKeyA	Key A for sector.
aKeyB	Key B for sector.
aAccessBits	Accessbits for sector.
aBlockArray	Data block array for sector.

Return Value: Pointer to the newly created instance.

NewLC ( TSectorType )

IMPORT_C CMifareClassicSector *

NewLC

(

TSectorType

aSize

)

[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aSize	Describes whether sector is 1 or 4 kilobytes.

Return Value: Pointer to the newly created instance.

NewLC ( CMifareClassicSector & )

IMPORT_C CMifareClassicSector *

NewLC

(

CMifareClassicSector &

aSector

)

[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aSector	Mifare classic sector which content is copied to this object.

Return Value: Pointer to the newly created instance.

NewLC ( const TDesC8 & )

IMPORT_C CMifareClassicSector *

NewLC

(

const TDesC8 &

aData

)

[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aData	Descriptor which content will be copied to this object.

Return Value: Pointer to the newly created instance.

NewLC ( const TDesC8 &, const TDesC8 &, const CMifareClassicAccessBits &, const RPointerArray< CMifareClassicDataBlock > & )

IMPORT_C CMifareClassicSector *	NewLC	(	const TDesC8 &	aKeyA,
			const TDesC8 &	aKeyB,
			const CMifareClassicAccessBits &	aAccessBits,
			const RPointerArray< CMifareClassicDataBlock > &	aBlockArray
		)	[static]

Creates a new instance of this class. May leave with one of the system wide error codes.

Parameters
aKeyA	Key A for sector.
aKeyB	Key B for sector.
aAccessBits	Accessbits for sector.
aBlockArray	Data block array for sector.

Return Value: Pointer to the newly created instance.

SectorType ( )

IMPORT_C TSectorType

SectorType

(

)

const

Returns TSectorType of this CMifareClassicSector.

Return Value: TSectorType of this CMifareClassicSector.

SetAccessBits ( const CMifareClassicAccessBits & )

IMPORT_C void

SetAccessBits

(

const CMifareClassicAccessBits &

aAccessBits

)

Sets specified CMifareClassicAccessBits for this CMifareClassicSector by replacing any existing data.

Parameters
aAccessBits	New access bits for sector.

SetAccessConditionForDataBlock ( TUint8, const MifareClassicCommon::TDataBlockAccessCondition & )

IMPORT_C TInt	SetAccessConditionForDataBlock	(	TUint8	aBlockNumber,
			const MifareClassicCommon::TDataBlockAccessCondition &	aAccessCondition
		)

Sets access condition for specified data block.

Parameters
aBlockNumber	Block number
aAccessCondition	Accesscondition

Return Values

KErrArgument	if block number is greater than 2.
KErrNone	if successful.

SetAccessConditionForSectorTrailer ( const MifareClassicCommon::TSectorTrailerAccessCondition & )

IMPORT_C void

SetAccessConditionForSectorTrailer

(

const MifareClassicCommon::TSectorTrailerAccessCondition &

aAccessCondition

)

Sets access condition for sector trailer.

Parameters
aAccessCondition	Access condition for sector trailer.

SetDataBlock ( TUint8, const CMifareClassicDataBlock & )

IMPORT_C TInt	SetDataBlock	(	TUint8	aBlockNumber,
			const CMifareClassicDataBlock &	aDataBlock
		)

Sets datablock.

Parameters
aBlockNumber	Block number.
aDataBlock	Data block.

Return Values

KErrArgument	If block number is greater than 2.
KErrNone	If successfull.

SetDataBlock ( TUint8, const TDesC8 & )

IMPORT_C TInt	SetDataBlock	(	TUint8	aBlockNumber,
			const TDesC8 &	aData
		)

Sets datablock.

Parameters
aBlockNumber	Block number.
aData	Data

Return Values

KErrArgument	If aData parameter's size is not 16 bytes.
KErrNone	If successfull.

SetSecretKey ( MifareClassicCommon::TKeyType, const TDesC8 & )

IMPORT_C TInt	SetSecretKey	(	MifareClassicCommon::TKeyType	aKeyType,
			const TDesC8 &	aKey
		)

Sets secret key of the mifare classic sector.

Parameters
aKeyType	aKeyType, the keytype of secret key.
aKey	Secret key, which size of key must be 6 bytes.

Return Values

KErrArgument	If size of aKeyType differ from 6 bytes.
KErrNone	If successful

operator!= ( const CMifareClassicSector & )

IMPORT_C TBool

operator!=

(

const CMifareClassicSector &

aSector

)

const

Determines whether this CMifareClassicSector is equal with specified CMifareClassicSector.

Parameters
aSector	CMifareClassicSector which is compared to this CMifareClassicSector.

operator== ( const CMifareClassicSector & )

IMPORT_C TBool

operator==

(

const CMifareClassicSector &

aSector

)

const

Determines whether this CMifareClassicSector is equal with specified CMifareClassicSector.

Parameters
aSector	CMifareClassicSector which is compared to this CMifareClassicSector.