Symbian^3 Product 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 TUint32Int()
IMPORT_C TUint16MainState()
IMPORT_C TSsmStateNameName()
IMPORT_C voidSet(TUint16, TUint16)
IMPORT_C voidSetFromInt(TUint32)
IMPORT_C TUint16SubState()
IMPORT_C TBooloperator!=(const TSsmState &)
IMPORT_C TSsmState &operator=(const TSsmState &)
IMPORT_C TBooloperator==(const TSsmState &)
Private Attributes
TUint16 iMainState
TUint16 iSubState

Constructor & Destructor Documentation

TSsmState()

IMPORT_CTSsmState()

Default constructor. Initialise this object to 0.

TSsmState(TSsmMainSystemStates, TUint16)

IMPORT_CTSsmState(TSsmMainSystemStatesaMainState,
TUint16aSubState
)

Constructor taking aMainState and aSubState as two separate arguments.

Parameters

TSsmMainSystemStates aMainStateThe main state to be assigned to this object.
TUint16 aSubStateThe sub state to be assigned to this object.

TSsmState(TUint16, TUint16)

IMPORT_CTSsmState(TUint16aMainState,
TUint16aSubState
)

Constructor taking aMainState and aSubState as two separate arguments.

Parameters

TUint16 aMainStateThe main state to be assigned to this object.
TUint16 aSubStateThe sub state to be assigned to this object.

TSsmState(const TSsmState &)

IMPORT_CTSsmState(const TSsmState &aState)

Copy constructor.

Parameters

const TSsmState & aStateThe value to be assigned to this object.

Member Functions Documentation

Int()

IMPORT_C TUint32Int()const

MainState()

IMPORT_C TUint16MainState()const

Name()

IMPORT_C TSsmStateNameName()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 voidSet(TUint16aMainState,
TUint16aSubState
)

Set member data.

Parameters

TUint16 aMainStateThe major state to be assigned to this object.
TUint16 aSubStateThe sub state to be assigned to this object.

SetFromInt(TUint32)

IMPORT_C voidSetFromInt(TUint32aValue)

Set member data using a 32-bit unsigned integer.

Parameters

TUint32 aValue

SubState()

IMPORT_C TUint16SubState()const

operator!=(const TSsmState &)

IMPORT_C TBooloperator!=(const TSsmState &aState)const

Parameters

const TSsmState & aStateThe value to be compared.

operator=(const TSsmState &)

IMPORT_C TSsmState &operator=(const TSsmState &aState)

Parameters

const TSsmState & aStateThe value to be assigned to this object.

operator==(const TSsmState &)

IMPORT_C TBooloperator==(const TSsmState &aState)const

Parameters

const TSsmState & aStateThe value to be compared.

Member Data Documentation

TUint16 iMainState

TUint16 iMainState[private]

TUint16 iSubState

TUint16 iSubState[private]

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.