dependencies/ssm/ssmstate.h
author kashif.sayed
Fri, 26 Mar 2010 02:16:01 +0530
branchv5backport
changeset 28 c98d4e1e5d8e
permissions -rw-r--r--
user: kashif.sayed added dependencies/ssm/ssmdomaindefs.h added dependencies/ssm/ssmstate.h added dependencies/ssm/ssmstateawaresession.h changed dependencies/ssm/bld.inf
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
28
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     1
// Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     2
// All rights reserved.
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     3
// This component and the accompanying materials are made available
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     4
// under the terms of "Eclipse Public License v1.0"
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     5
// which accompanies this distribution, and is available
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     7
//
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     8
// Initial Contributors:
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
     9
// Nokia Corporation - initial contribution.
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    10
//
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    11
// Contributors:
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    12
//
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    13
// Description:
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    14
//
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    15
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    16
#ifndef __SSMSTATE_H__
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    17
#define __SSMSTATE_H__
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    18
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    19
#include <e32std.h>
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    20
#include <ssm/ssmstates.hrh>
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    21
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    22
/**
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    23
 The maximum length of a System State Name
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    24
 
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    25
 @see TSsmState
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    26
 
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    27
 @publishedPartner
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    28
 @released
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    29
 */
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    30
const TInt KMaxSsmStateName = 11;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    31
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    32
/**
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    33
 A buffer for a System State Name
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    34
 
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    35
 @see TSsmState
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    36
  
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    37
 @publishedPartner
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    38
@released
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    39
 */
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    40
typedef TBuf<KMaxSsmStateName> TSsmStateName;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    41
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    42
/**
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    43
 Encapsulates the System State.
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    44
 
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    45
 @publishedPartner
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    46
@released
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    47
 */
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    48
NONSHARABLE_CLASS(TSsmState)
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    49
	{
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    50
public:
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    51
	IMPORT_C TSsmState();
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    52
	IMPORT_C TSsmState(TSsmMainSystemStates aMainState, TUint16 aSubState);
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    53
	IMPORT_C TSsmState(TUint16 aMainState, TUint16 aSubState);
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    54
	IMPORT_C TSsmState(const TSsmState& aState);
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    55
	IMPORT_C TUint16 MainState() const;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    56
	IMPORT_C TUint16 SubState() const;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    57
	IMPORT_C void Set(TUint16 aMainState, TUint16 aSubState);
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    58
	IMPORT_C TUint32 Int() const;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    59
	IMPORT_C void SetFromInt(TUint32 aValue);
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    60
	IMPORT_C TSsmStateName Name() const;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    61
	IMPORT_C TSsmState& operator=(const TSsmState& aState);
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    62
	IMPORT_C TBool operator==(const TSsmState& aState) const;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    63
	IMPORT_C TBool operator!=(const TSsmState& aState) const;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    64
private:
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    65
	TUint16 iMainState;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    66
	TUint16 iSubState;
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    67
	};
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    68
c98d4e1e5d8e user: kashif.sayed
kashif.sayed
parents:
diff changeset
    69
#endif