epoc32/include/cs_subconparams.inl
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
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.
williamr@2
     1
// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
/**
williamr@2
    17
 @file
williamr@2
    18
 @publishedAll
williamr@4
    19
 @released
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
#ifndef __CS_SUBCONPARAMS_INL__
williamr@2
    23
#define __CS_SUBCONPARAMS_INL__
williamr@2
    24
williamr@2
    25
CSubConQosGenericParamSet* CSubConQosGenericParamSet::NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType)
williamr@4
    26
/** Creates a generic Qos family parameterset.
williamr@2
    27
williamr@4
    28
Note:
williamr@4
    29
The aFamily parameter that is passed into this method will take ownership of the newly 
williamr@4
    30
created CSubConQosGenericParamSet object.  When the family is destroyed, this parameter 
williamr@4
    31
set object will also be destroyed (along with any other parameter sets owned by the family).
williamr@4
    32
williamr@4
    33
@param aFamily Parameter sets.
williamr@4
    34
@param aType Parameter type (Requested/Acceptable/Granted)
williamr@2
    35
@return a CSubConQosGenericParamSet object pointer if successful,
williamr@4
    36
 otherwise leaves with a system error code.
williamr@2
    37
*/
williamr@2
    38
	{
williamr@2
    39
	CSubConQosGenericParamSet* obj = NewL();
williamr@2
    40
	CleanupStack::PushL(obj);
williamr@2
    41
	aFamily.SetGenericSetL(*obj, aType);
williamr@2
    42
	CleanupStack::Pop(obj);
williamr@2
    43
	return obj;
williamr@2
    44
	}
williamr@2
    45
williamr@4
    46
CSubConQosGenericParamSet* CSubConQosGenericParamSet::NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType)
williamr@4
    47
/** Creates a generic Qos family parameterset.
williamr@4
    48
williamr@4
    49
Note:
williamr@4
    50
The aFamily parameter that is passed into this method will take ownership of the newly 
williamr@4
    51
created CSubConQosGenericParamSet object.  When the family is destroyed, this parameter 
williamr@4
    52
set object will also be destroyed (along with any other parameter sets owned by the family).
williamr@4
    53
williamr@4
    54
@param aFamily Parameter sets.
williamr@4
    55
@param aType Parameter type (Requested/Acceptable/Granted)
williamr@4
    56
@return a CSubConQosGenericParamSet object pointer if successful,
williamr@4
    57
 otherwise leaves with a system error code.
williamr@4
    58
*/
williamr@4
    59
	{
williamr@4
    60
	CSubConQosGenericParamSet* obj = NewL();
williamr@4
    61
	CleanupStack::PushL(obj);
williamr@4
    62
	aFamily.AddParameterSetL(obj, aType);
williamr@4
    63
	CleanupStack::Pop(obj);
williamr@4
    64
	return obj;
williamr@4
    65
	}
williamr@4
    66
williamr@2
    67
CSubConQosGenericParamSet* CSubConQosGenericParamSet::NewL()
williamr@4
    68
/** Creates a generic Qos family parameterset.
williamr@2
    69
williamr@2
    70
@return a CSubConQosGenericParamSet object pointer if successful,
williamr@4
    71
 otherwise leaves with a system error code.
williamr@2
    72
*/
williamr@2
    73
	{
williamr@4
    74
	STypeId typeId = STypeId::CreateSTypeId(CSubConQosGenericParamSet::EUid, CSubConQosGenericParamSet::EType);
williamr@2
    75
	return static_cast<CSubConQosGenericParamSet*>(CSubConParameterSet::NewL(typeId));
williamr@2
    76
	}
williamr@2
    77
williamr@2
    78
CSubConQosGenericParamSet::CSubConQosGenericParamSet()
williamr@2
    79
	: CSubConGenericParameterSet(),
williamr@2
    80
	iDownlinkBandwidth(0),
williamr@2
    81
	iUplinkBandwidth(0),
williamr@2
    82
	iDownLinkMaximumBurstSize(0),
williamr@2
    83
	iUpLinkMaximumBurstSize(0),
williamr@2
    84
	iDownLinkAveragePacketSize(0),
williamr@2
    85
	iUpLinkAveragePacketSize(0),
williamr@2
    86
	iDownLinkMaximumPacketSize(0),
williamr@2
    87
	iUpLinkMaximumPacketSize(0),
williamr@2
    88
	iDownLinkDelay(0),
williamr@2
    89
	iUpLinkDelay(0),
williamr@2
    90
	iDownLinkDelayVariation(0),
williamr@2
    91
	iUpLinkDelayVariation(0),
williamr@2
    92
	iDownLinkPriority(0),
williamr@2
    93
	iUpLinkPriority(0),
williamr@2
    94
	iHeaderMode(EFalse)
williamr@2
    95
/** Empty CSubConQosGenericParamSet constructor
williamr@2
    96
*/
williamr@2
    97
	{
williamr@2
    98
	}
williamr@2
    99
williamr@2
   100
TInt CSubConQosGenericParamSet::GetDownlinkBandwidth() const
williamr@2
   101
/** Gets downlink bandwidth value.
williamr@2
   102
williamr@2
   103
@return downlink bandwidth value. */
williamr@2
   104
	{
williamr@2
   105
	return iDownlinkBandwidth;
williamr@2
   106
	}
williamr@2
   107
williamr@2
   108
TInt CSubConQosGenericParamSet::GetUplinkBandwidth() const
williamr@2
   109
/** Gets uplink bandwidth value.
williamr@2
   110
williamr@2
   111
@return uplink bandwidth value. */
williamr@2
   112
	{
williamr@2
   113
	return iUplinkBandwidth;
williamr@2
   114
	}
williamr@2
   115
williamr@2
   116
TInt CSubConQosGenericParamSet::GetDownLinkMaximumBurstSize() const
williamr@2
   117
/** Gets downlink max burst size client can handle.
williamr@2
   118
williamr@2
   119
@return downlink max burst size . */
williamr@2
   120
	{
williamr@2
   121
	return iDownLinkMaximumBurstSize;
williamr@2
   122
	}
williamr@2
   123
williamr@2
   124
TInt CSubConQosGenericParamSet::GetUpLinkMaximumBurstSize() const
williamr@2
   125
/** Gets uplink max burst size client can handle.
williamr@2
   126
williamr@2
   127
@return uplink max burst size . */
williamr@2
   128
	{
williamr@2
   129
	return iUpLinkMaximumBurstSize;
williamr@2
   130
	}
williamr@2
   131
williamr@2
   132
TInt CSubConQosGenericParamSet::GetDownLinkAveragePacketSize() const
williamr@2
   133
/** Gets downlink average packet size required.
williamr@2
   134
williamr@2
   135
@return downlink average packet size . */
williamr@2
   136
	{
williamr@2
   137
	return iDownLinkAveragePacketSize;
williamr@2
   138
	}
williamr@2
   139
williamr@2
   140
TInt CSubConQosGenericParamSet::GetUpLinkAveragePacketSize() const
williamr@2
   141
/** Gets uplink average packet size required.
williamr@2
   142
williamr@2
   143
@return uplink average packet size . */
williamr@2
   144
	{
williamr@2
   145
	return iUpLinkAveragePacketSize;
williamr@2
   146
	}
williamr@2
   147
williamr@2
   148
TInt CSubConQosGenericParamSet::GetDownLinkMaximumPacketSize() const
williamr@2
   149
/** Gets downlink max packet size client can handle.
williamr@2
   150
williamr@2
   151
@return downlink max packet size . */
williamr@2
   152
	{
williamr@2
   153
	return iDownLinkMaximumPacketSize;
williamr@2
   154
	}
williamr@2
   155
williamr@2
   156
TInt CSubConQosGenericParamSet::GetUpLinkMaximumPacketSize() const
williamr@2
   157
/** Gets uplink max packet size client can handle.
williamr@2
   158
williamr@2
   159
@return uplink max packet size . */
williamr@2
   160
	{
williamr@2
   161
	return iUpLinkMaximumPacketSize;
williamr@2
   162
	}
williamr@2
   163
williamr@2
   164
TInt CSubConQosGenericParamSet::GetDownLinkDelay() const
williamr@2
   165
/** Gets acceptable downlink delay value.
williamr@2
   166
williamr@2
   167
@return downlink delay value. */
williamr@2
   168
	{
williamr@2
   169
	return iDownLinkDelay;
williamr@2
   170
	}
williamr@2
   171
williamr@2
   172
TInt CSubConQosGenericParamSet::GetUpLinkDelay() const
williamr@2
   173
/** Gets acceptable uplink delay value.
williamr@2
   174
williamr@2
   175
@return uplink delay value. */
williamr@2
   176
	{
williamr@2
   177
	return iUpLinkDelay;
williamr@2
   178
	}
williamr@2
   179
williamr@2
   180
TInt CSubConQosGenericParamSet::GetDownLinkDelayVariation() const
williamr@2
   181
/** Gets acceptable downlink delay variation value.
williamr@2
   182
williamr@2
   183
@return downlink delay variation value. */
williamr@2
   184
	{
williamr@2
   185
	return iDownLinkDelayVariation;
williamr@2
   186
	}
williamr@2
   187
williamr@2
   188
TInt CSubConQosGenericParamSet::GetUpLinkDelayVariation() const
williamr@2
   189
/** Gets acceptable uplink delay variation value.
williamr@2
   190
williamr@2
   191
@return uplink delay variation value. */
williamr@2
   192
	{
williamr@2
   193
	return iUpLinkDelayVariation;
williamr@2
   194
	}
williamr@2
   195
williamr@2
   196
TInt CSubConQosGenericParamSet::GetDownLinkPriority() const
williamr@2
   197
/** Gets downlink priority value (relative to other channel's priority).
williamr@2
   198
williamr@2
   199
@return downlink priority value. */
williamr@2
   200
	{
williamr@2
   201
	return iDownLinkPriority;
williamr@2
   202
	}
williamr@2
   203
williamr@2
   204
TInt CSubConQosGenericParamSet::GetUpLinkPriority() const
williamr@2
   205
/** Gets uplink priority value (relative to other channel's priority).
williamr@2
   206
williamr@2
   207
@return uplink priority value. */
williamr@2
   208
	{
williamr@2
   209
	return iUpLinkPriority;
williamr@2
   210
	}
williamr@2
   211
williamr@2
   212
TBool CSubConQosGenericParamSet::GetHeaderMode() const
williamr@2
   213
/** Gets header mode.
williamr@2
   214
williamr@4
   215
@return boolean value indicating whether the header size
williamr@2
   216
should be calculated by the QoS module or specified by the client. */
williamr@2
   217
	{
williamr@2
   218
	return iHeaderMode;
williamr@2
   219
	}
williamr@2
   220
williamr@2
   221
const TName& CSubConQosGenericParamSet::GetName() const
williamr@2
   222
/** Gets Qos Parameter set name.
williamr@2
   223
williamr@2
   224
@return Qos Parameter set name. */
williamr@2
   225
	{
williamr@2
   226
	return iName;
williamr@2
   227
	}
williamr@2
   228
williamr@2
   229
void CSubConQosGenericParamSet::SetDownlinkBandwidth(TInt aDownlinkBandwidth)
williamr@2
   230
/** Sets downlink bandwidth value.
williamr@2
   231
williamr@2
   232
@param aDownlinkBandwidth downlink bandwidth value. */
williamr@2
   233
	{
williamr@2
   234
	iDownlinkBandwidth = aDownlinkBandwidth;
williamr@2
   235
	}
williamr@2
   236
williamr@2
   237
void CSubConQosGenericParamSet::SetUplinkBandwidth(TInt aUplinkBandwidth)
williamr@2
   238
/** Sets uplink bandwidth value.
williamr@2
   239
williamr@2
   240
@param aUplinkBandwidth uplink bandwidth value. */
williamr@2
   241
	{
williamr@2
   242
	iUplinkBandwidth = aUplinkBandwidth;
williamr@2
   243
	}
williamr@2
   244
williamr@2
   245
void CSubConQosGenericParamSet::SetDownLinkMaximumBurstSize(TInt aDownLinkMaximumBurstSize)
williamr@2
   246
/** Sets downlink max burst size client can handle.
williamr@2
   247
williamr@2
   248
@param aDownLinkMaximumBurstSize downlink max burst size . */
williamr@2
   249
	{
williamr@2
   250
	iDownLinkMaximumBurstSize = aDownLinkMaximumBurstSize;
williamr@2
   251
	}
williamr@2
   252
williamr@2
   253
void CSubConQosGenericParamSet::SetUpLinkMaximumBurstSize(TInt aUpLinkMaximumBurstSize)
williamr@2
   254
/** Sets uplink max burst size client can handle.
williamr@2
   255
williamr@2
   256
@param aUpLinkMaximumBurstSize uplink max burst size . */
williamr@2
   257
	{
williamr@2
   258
	iUpLinkMaximumBurstSize = aUpLinkMaximumBurstSize;
williamr@2
   259
	}
williamr@2
   260
williamr@2
   261
void CSubConQosGenericParamSet::SetDownLinkAveragePacketSize(TInt aDownLinkAveragePacketSize)
williamr@2
   262
/** Sets downlink average packet size required.
williamr@2
   263
williamr@2
   264
@param aDownLinkAveragePacketSize downlink average packet size . */
williamr@2
   265
	{
williamr@2
   266
	iDownLinkAveragePacketSize = aDownLinkAveragePacketSize;
williamr@2
   267
	}
williamr@2
   268
williamr@2
   269
void CSubConQosGenericParamSet::SetUpLinkAveragePacketSize(TInt aUpLinkAveragePacketSize)
williamr@2
   270
/** Sets uplink average packet size required.
williamr@2
   271
williamr@2
   272
@param aUpLinkAveragePacketSize uplink average packet size . */
williamr@2
   273
	{
williamr@2
   274
	iUpLinkAveragePacketSize = aUpLinkAveragePacketSize;
williamr@2
   275
	}
williamr@2
   276
williamr@2
   277
void CSubConQosGenericParamSet::SetDownLinkMaximumPacketSize(TInt aDownLinkMaximumPacketSize)
williamr@2
   278
/** Sets downlink max packet size client can handle.
williamr@2
   279
williamr@2
   280
@param aDownLinkMaximumPacketSize downlink max packet size . */
williamr@2
   281
	{
williamr@2
   282
	iDownLinkMaximumPacketSize = aDownLinkMaximumPacketSize;
williamr@2
   283
	}
williamr@2
   284
williamr@2
   285
void CSubConQosGenericParamSet::SetUpLinkMaximumPacketSize(TInt aUpLinkMaximumPacketSize)
williamr@2
   286
/** Sets uplink max packet size client can handle.
williamr@2
   287
williamr@2
   288
@param aUpLinkMaximumPacketSize uplink max packet size . */
williamr@2
   289
	{
williamr@2
   290
	iUpLinkMaximumPacketSize = aUpLinkMaximumPacketSize;
williamr@2
   291
	}
williamr@2
   292
williamr@2
   293
void CSubConQosGenericParamSet::SetDownLinkDelay(TInt aDownLinkDelay)
williamr@2
   294
/** Sets acceptable downlink delay value.
williamr@2
   295
williamr@2
   296
@param aDownLinkDelay downlink delay value. */
williamr@2
   297
	{
williamr@2
   298
	iDownLinkDelay = aDownLinkDelay;
williamr@2
   299
	}
williamr@2
   300
williamr@2
   301
void CSubConQosGenericParamSet::SetUpLinkDelay(TInt aUpLinkDelay)
williamr@2
   302
/** Sets acceptable uplink delay value.
williamr@2
   303
williamr@2
   304
@param aUpLinkDelay uplink delay value. */
williamr@2
   305
	{
williamr@2
   306
	iUpLinkDelay = aUpLinkDelay;
williamr@2
   307
	}
williamr@2
   308
williamr@2
   309
void CSubConQosGenericParamSet::SetDownLinkDelayVariation(TInt aDownLinkDelayVariation)
williamr@2
   310
/** Sets acceptable downlink delay variation value.
williamr@2
   311
williamr@2
   312
@param aDownLinkDelayVariation downlink delay variation value. */
williamr@2
   313
	{
williamr@2
   314
	iDownLinkDelayVariation = aDownLinkDelayVariation;
williamr@2
   315
	}
williamr@2
   316
williamr@2
   317
void CSubConQosGenericParamSet::SetUpLinkDelayVariation(TInt aUpLinkDelayVariation)
williamr@2
   318
/** Sets acceptable uplink delay variation value.
williamr@2
   319
williamr@2
   320
@param aUpLinkDelayVariation uplink delay variation value. */
williamr@2
   321
	{
williamr@2
   322
	iUpLinkDelayVariation = aUpLinkDelayVariation;
williamr@2
   323
	}
williamr@2
   324
williamr@2
   325
void CSubConQosGenericParamSet::SetDownLinkPriority(TInt aDownLinkPriority)
williamr@2
   326
/** Sets downlink priority value (relative to other channel's priority).
williamr@2
   327
williamr@2
   328
@param aDownLinkPriority downlink priority value. */
williamr@2
   329
	{
williamr@2
   330
	iDownLinkPriority = aDownLinkPriority;
williamr@2
   331
	}
williamr@2
   332
williamr@2
   333
void CSubConQosGenericParamSet::SetUpLinkPriority(TInt aUpLinkPriority)
williamr@2
   334
/** Sets uplink priority value (relative to other channel's priority).
williamr@2
   335
williamr@2
   336
@param aUpLinkPriority uplink priority value. */
williamr@2
   337
	{
williamr@2
   338
	iUpLinkPriority = aUpLinkPriority;
williamr@2
   339
	}
williamr@2
   340
williamr@2
   341
void CSubConQosGenericParamSet::SetHeaderMode(TBool aHeaderMode)
williamr@2
   342
/** Sets header mode.
williamr@2
   343
williamr@4
   344
@param aHeaderMode boolean value indicating whether the header size
williamr@2
   345
should be calculated by the QoS module or specified by the client. */
williamr@2
   346
	{
williamr@2
   347
	iHeaderMode = aHeaderMode;
williamr@2
   348
	}
williamr@2
   349
williamr@2
   350
void CSubConQosGenericParamSet::SetName(const TName& aName)
williamr@2
   351
/** Sets Qos Parameter set name.
williamr@2
   352
williamr@2
   353
@param aName Qos Parameter set name. */
williamr@2
   354
	{
williamr@2
   355
	iName = aName;
williamr@2
   356
	}
williamr@2
   357
williamr@2
   358
//=============
williamr@2
   359
CSubConAuthorisationGenericParamSet* CSubConAuthorisationGenericParamSet::NewL(CSubConParameterFamily& aFamily, CSubConParameterFamily::TParameterSetType aType)
williamr@4
   360
/** Creates a generic Authorisation family parameterset.
williamr@4
   361
williamr@4
   362
Note:
williamr@4
   363
The aFamily parameter that is passed into this method will take ownership of the newly 
williamr@4
   364
created CSubConAuthorisationGenericParamSet object.  When the family is destroyed, this 
williamr@4
   365
parameter set object will also be destroyed (along with any other parameter sets owned 
williamr@4
   366
by the family).
williamr@2
   367
williamr@2
   368
@param aFamily parameter sets.
williamr@4
   369
@param aType parameter type (Requested/Acceptable/Granted)
williamr@2
   370
@return a CSubConAuthorisationGenericParamSet object pointer if successful,
williamr@4
   371
 otherwise leaves with a system error code.
williamr@2
   372
*/
williamr@2
   373
	{
williamr@2
   374
	CSubConAuthorisationGenericParamSet* obj = NewL();
williamr@2
   375
	CleanupStack::PushL(obj);
williamr@2
   376
	aFamily.SetGenericSetL(*obj, aType);
williamr@2
   377
	CleanupStack::Pop(obj);
williamr@2
   378
	return obj;
williamr@2
   379
	}
williamr@2
   380
williamr@4
   381
CSubConAuthorisationGenericParamSet* CSubConAuthorisationGenericParamSet::NewL(RParameterFamily& aFamily, RParameterFamily::TParameterSetType aType)
williamr@4
   382
/** Creates a generic Authorisation family parameterset.
williamr@4
   383
williamr@4
   384
Note:
williamr@4
   385
The aFamily parameter that is passed into this method will take ownership of the newly 
williamr@4
   386
created CSubConAuthorisationGenericParamSet object.  When the family is destroyed, this 
williamr@4
   387
parameter set object will also be destroyed (along with any other parameter sets owned 
williamr@4
   388
by the family).
williamr@4
   389
williamr@4
   390
@param aFamily parameter sets.
williamr@4
   391
@param aType parameter type (Requested/Acceptable/Granted)
williamr@4
   392
@return a CSubConAuthorisationGenericParamSet object pointer if successful,
williamr@4
   393
 otherwise leaves with a system error code.
williamr@4
   394
*/
williamr@4
   395
	{
williamr@4
   396
	CSubConAuthorisationGenericParamSet* obj = NewL();
williamr@4
   397
	CleanupStack::PushL(obj);
williamr@4
   398
	aFamily.AddParameterSetL(obj, aType);
williamr@4
   399
	CleanupStack::Pop(obj);
williamr@4
   400
	return obj;
williamr@4
   401
	}
williamr@4
   402
williamr@2
   403
CSubConAuthorisationGenericParamSet* CSubConAuthorisationGenericParamSet::NewL()
williamr@4
   404
/** Creates a generic Authorisation family parameterset.
williamr@2
   405
williamr@2
   406
@return a CSubConAuthorisationGenericParamSet object pointer if successful,
williamr@4
   407
 otherwise leaves with a system error code.
williamr@2
   408
*/
williamr@2
   409
	{
williamr@4
   410
	STypeId typeId = STypeId::CreateSTypeId(CSubConAuthorisationGenericParamSet::EUid, CSubConAuthorisationGenericParamSet::EType);
williamr@2
   411
	return static_cast<CSubConAuthorisationGenericParamSet*>(CSubConParameterSet::NewL(typeId));
williamr@2
   412
	}
williamr@2
   413
williamr@2
   414
CSubConAuthorisationGenericParamSet::CSubConAuthorisationGenericParamSet()
williamr@4
   415
	: CSubConGenericParameterSet(),
williamr@2
   416
	iId(0)
williamr@2
   417
/** Empty CSubConAuthorisationGenericParamSet constructor
williamr@2
   418
*/
williamr@2
   419
	{
williamr@2
   420
	}
williamr@2
   421
williamr@2
   422
TInt CSubConAuthorisationGenericParamSet::GetId() const
williamr@2
   423
/** Gets Id of Authorisation Parameter set.
williamr@2
   424
williamr@2
   425
@return Id of Authorisation Parameter set. */
williamr@2
   426
	{
williamr@2
   427
	return iId;
williamr@2
   428
	}
williamr@2
   429
williamr@2
   430
void CSubConAuthorisationGenericParamSet::SetId(TInt aId)
williamr@2
   431
/** Sets Id of Authorisation Parameter set.
williamr@2
   432
williamr@2
   433
@param aId Id of Authorisation Parameter set. */
williamr@2
   434
	{
williamr@2
   435
	iId = aId;
williamr@2
   436
	}
williamr@4
   437
williamr@2
   438
#endif	// __CS_SUBCONPARAMS_INL__
williamr@4
   439