epoc32/include/comms-infras/es_parameterset.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
     1 // Copyright (c) 2007-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 // Generic parameter set base classes.
    15 // XParameterSetBase exists to support interworking with old CSubConParameterSet classes.
    16 // XParameterSet has richer functionality so should be used for all new applications of Parameter Sets.
    17 // 
    18 //
    19 
    20 /**
    21  @file
    22  @internalTechnology
    23 */
    24 
    25 #ifndef __ES_PARAMETERSET_H
    26 #define __ES_PARAMETERSET_H
    27 
    28 #include <comms-infras/metadata.h>
    29 
    30 class XParameterSetBase : public Meta::SMetaDataECom
    31 	{
    32 	};
    33 
    34 
    35 const TInt KParameterSetTypeUid = 0x10272F44;
    36 
    37 class XParameterSet : public XParameterSetBase
    38 	{
    39 public:
    40 	IMPORT_C virtual ~XParameterSet();
    41 
    42 	// Updates this parameter set with new information. The interpretation and 
    43 	//  importance of new information may depend on type-specific interpretation
    44 	//  of the fields in the object (e.g. a field somehow marked "unknown" in the new
    45 	//  set should not be copied to this set, or some kind of lock on a
    46 	//  field in this set should prevent that field being copied from the
    47 	//  new set).
    48 	//
    49 	// This base implementation asserts, so as to force the consideration of this
    50 	//  function for derived types.
    51 	IMPORT_C virtual void UpdateWithL(const XParameterSet& aRhsBase);
    52 	IMPORT_C virtual TInt AppendPrintableTo(TDes& aDestination) const;
    53 	IMPORT_C virtual TInt _extension(TUid aExtensionId, TAny*& aReturnedExtension);
    54 
    55 protected:
    56     // It's necessary to expose the typeid table to child classes so they can refer to it in their attribute tables (so IsTypeOf() works)
    57 	EXPORT_TYPEID_TABLE
    58 	};
    59 
    60 #endif // __ES_PARAMETERSET_H
    61