Collapse all Symbian^3 Application Developer Library

TSsmState Class Reference

class TSsmState

Encapsulates the System State.

Public Member Functions
	TSsmState ()
	TSsmState ( TSsmMainSystemStates , TUint16 )
	TSsmState ( TUint16 , TUint16 )
	TSsmState (const TSsmState &)
IMPORT_C TUint32	Int ()
IMPORT_C TUint16	MainState ()
IMPORT_C TSsmStateName	Name ()
IMPORT_C void	Set ( TUint16 , TUint16 )
IMPORT_C void	SetFromInt ( TUint32 )
IMPORT_C TUint16	SubState ()
IMPORT_C TBool	operator!= (const TSsmState &)
IMPORT_C TSsmState &	operator= (const TSsmState &)
IMPORT_C TBool	operator== (const TSsmState &)

Private Attributes
TUint16	iMainState
TUint16	iSubState

Constructor & Destructor Documentation

TSsmState()

IMPORT_C

TSsmState

(

)

Default constructor. Initialise this object to 0.

TSsmState(TSsmMainSystemStates, TUint16)

IMPORT_C	TSsmState	(	TSsmMainSystemStates	aMainState,
			TUint16	aSubState
		)

Constructor taking aMainState and aSubState as two separate arguments.

Parameters

TSsmMainSystemStates aMainState	The main state to be assigned to this object.
TUint16 aSubState	The sub state to be assigned to this object.

TSsmState(TUint16, TUint16)

IMPORT_C	TSsmState	(	TUint16	aMainState,
			TUint16	aSubState
		)

Constructor taking aMainState and aSubState as two separate arguments.

Parameters

TUint16 aMainState	The main state to be assigned to this object.
TUint16 aSubState	The sub state to be assigned to this object.

TSsmState(const TSsmState &)

IMPORT_C

TSsmState

(

const TSsmState &

aState

)

Copy constructor.

Parameters

const TSsmState & aState

The value to be assigned to this object.

Member Functions Documentation

Int()

IMPORT_C TUint32

Int

(

)

const

MainState()

IMPORT_C TUint16

MainState

(

)

const

Name()

IMPORT_C TSsmStateName

Name

(

)

const

Gives a textual description of the values assigned to this object. E.g. ESsmStartup.KSsmAnySubState is formated as 0000.FFFF

Set(TUint16, TUint16)

IMPORT_C void	Set	(	TUint16	aMainState,
			TUint16	aSubState
		)

Set member data.

Parameters

TUint16 aMainState	The major state to be assigned to this object.
TUint16 aSubState	The sub state to be assigned to this object.

SetFromInt(TUint32)

IMPORT_C void

SetFromInt

(

TUint32

aValue

)

Set member data using a 32-bit unsigned integer.

Parameters

TUint32 aValue

SubState()

IMPORT_C TUint16

SubState

(

)

const

operator!=(const TSsmState &)

IMPORT_C TBool

operator!=

(

const TSsmState &

aState

)

const

Parameters

const TSsmState & aState

The value to be compared.

operator=(const TSsmState &)

IMPORT_C TSsmState &

operator=

(

const TSsmState &

aState

)

Parameters

const TSsmState & aState

The value to be assigned to this object.

operator==(const TSsmState &)

IMPORT_C TBool

operator==

(

const TSsmState &

aState

)

const

Parameters

const TSsmState & aState

The value to be compared.

Member Data Documentation

TUint16 iMainState

TUint16

iMainState

[private]

TUint16 iSubState

TUint16

iSubState

[private]