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