test: epoc32/include/smuthdr.inl@2fe1408b6811

     1 // Copyright (c) 1999-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    16 #include <smcmmain.h>

    17 #include <gsmumsg.h>

    19 /**

    20 Gets the message PDU for a SMS-SUBMIT type message.

    22 The message PDU type can be checked by using the CSmsHeader::Type API.

    24 @return

    25 The SMS-SUBMIT PDU object.

    27 @panic	SMCM	0

    28 The message was not a PDU of type SMS-SUBMIT (debug only).

    30 @see	CSmsHeader::Type

    31 */

    32 inline CSmsSubmit& CSmsHeader::Submit()

    33 	{

    34 	__ASSERT_DEBUG( Type() == CSmsPDU::ESmsSubmit, Panic(ESmutPanicUnsupportedMsgType));

    35 	return (CSmsSubmit&)(iMessage->SmsPDU());

    36 	}

    38 /**

    39 Gets the (const) message PDU for a SMS-SUBMIT type message.

    41 The message PDU type can be checked by using the CSmsHeader::Type API.

    43 @return

    44 The SMS-SUBMIT PDU const object.

    46 @panic	SMCM	0

    47 The message was not a PDU of type SMS-SUBMIT (debug only).

    49 @see	CSmsHeader::Type

    50 */

    51 inline const CSmsSubmit& CSmsHeader::Submit() const

    52 	{

    53 	__ASSERT_DEBUG( Type() == CSmsPDU::ESmsSubmit, Panic(ESmutPanicUnsupportedMsgType));

    54 	return (CSmsSubmit&)(iMessage->SmsPDU());

    55 	}

    57 /**

    58 Gets the message PDU for a SMS-DELIVER type message.

    60 The message PDU type can be checked by using the CSmsHeader::Type API.

    62 @return

    63 The SMS-DELIVER PDU object.

    65 @panic	SMCM	0

    66 The message was not a PDU of type SMS-DELIVER (debug only).

    68 @see	CSmsHeader::Type

    69 */

    70 inline CSmsDeliver& CSmsHeader::Deliver()

    71 	{

    72 	__ASSERT_DEBUG( Type() == CSmsPDU::ESmsDeliver, Panic(ESmutPanicUnsupportedMsgType));

    73 	return (CSmsDeliver&)(iMessage->SmsPDU());

    74 	}

    76 /**

    77 Gets the (const) message PDU for a SMS-DELIVER type message.

    79 The message PDU type can be checked by using the CSmsHeader::Type API.

    81 @return

    82 The SMS-DELIVER PDU const object.

    84 @panic	SMCM	0

    85 The message was not a PDU of type SMS-DELIVER (debug only).

    87 @see	CSmsHeader::Type

    88 */

    89 inline const CSmsDeliver& CSmsHeader::Deliver() const

    90 	{

    91 	__ASSERT_DEBUG( Type() == CSmsPDU::ESmsDeliver, Panic(ESmutPanicUnsupportedMsgType));

    92 	return (CSmsDeliver&)(iMessage->SmsPDU());

    93 	}

    95 /**

    96 Gets the message PDU for a SMS-COMMMAND type message.

    98 The message PDU type can be checked by using the CSmsHeader::Type API.

   100 @return	The SMS-COMMMAND PDU object.

   102 @panic	SMCM	0

   103 The message was not a PDU of type SMS-COMMMAND (debug only).

   105 @see	CSmsHeader::Type

   106 */

   107 inline CSmsCommand& CSmsHeader::Command()

   108 	{

   109 	__ASSERT_DEBUG( Type() == CSmsPDU::ESmsCommand, Panic(ESmutPanicUnsupportedMsgType));

   110 	return (CSmsCommand&)(iMessage->SmsPDU());

   111 	}

   113 /**

   114 Gets the (const) message PDU for a SMS-COMMMAND type message.

   116 The message PDU type can be checked by using the CSmsHeader::Type API.

   118 @return

   119 The SMS-COMMMAND PDU const object.

   121 @panic	SMCM	0

   122 The message was not a PDU of type SMS-COMMMAND (debug only).

   124 @see	CSmsHeader::Type

   125 */

   126 inline const CSmsCommand& CSmsHeader::Command() const

   127 	{

   128 	__ASSERT_DEBUG( Type() == CSmsPDU::ESmsCommand, Panic(ESmutPanicUnsupportedMsgType));

   129 	return (CSmsCommand&)(iMessage->SmsPDU());

   130 	}

   132 /**

   133 Gets the message PDU for a SMS-STATUS-REPORT type message.

   135 The message PDU type can be checked by using the CSmsHeader::Type API.

   137 @return

   138 The SMS-STATUS-REPORT PDU object.

   140 @panic	SMCM	0

   141 The message was not a PDU of type SMS-STATUS-REPORT (debug only).

   143 @see	CSmsHeader::Type

   144 */

   145 inline CSmsStatusReport& CSmsHeader::StatusReport()

   146 	{

   147 	__ASSERT_DEBUG( Type() == CSmsPDU::ESmsStatusReport, Panic(ESmutPanicUnsupportedMsgType));

   148 	return (CSmsStatusReport&)(iMessage->SmsPDU());

   149 	}

   151 /**

   152 Gets the (const) message PDU for a SMS-STATUS-REPORT type message.

   154 The message PDU type can be checked by using the CSmsHeader::Type API.

   156 @return

   157 The SMS-STATUS-REPORT PDU const object.

   159 @panic	SMCM	0

   160 The message was not a PDU of type SMS-STATUS-REPORT (debug only).

   162 @see	CSmsHeader::Type

   163 */

   164 inline const CSmsStatusReport& CSmsHeader::StatusReport() const

   165 	{

   166 	__ASSERT_DEBUG( Type() == CSmsPDU::ESmsStatusReport, Panic(ESmutPanicUnsupportedMsgType));

   167 	return (CSmsStatusReport&)(iMessage->SmsPDU());

   168 	}

   170 /**

   171 Gets the message PDU type.

   173 There are six types of PDU -  SMS-DELIVER, SMS-DELIVER-REPORT, SMS-SUBMIT,

   174 SMS-SUBMIT-REPORT, SMS-STATUS-REPORT and SMS-COMMAND.

   176 There is access to only to SMS-DELIVER, SMS-SUBMIT, SMS-STATUS-REPORT and

   177 SMS-COMMAND PDUs via the CSmsHeader encapsulation.

   179 @return

   180 The message PDU type.

   182 @see	CSmsPDU::TSmsPDUType

   183 */

   184 inline CSmsPDU::TSmsPDUType CSmsHeader::Type() const

   185 	{

   186 	return iMessage->SmsPDU().Type();

   187 	}

   189 /**

   190 Gets the (const) message recipients.

   192 @return

   193 The const array of message recipients

   194 */

   195 inline const CArrayPtrFlat<CSmsNumber>& CSmsHeader::Recipients() const

   196 	{

   197 	return iRecipients;

   198 	}

   200 /**

   201 Gets the (const) message recipients.

   203 @return

   204 The array of message recipients

   205 */

   206 inline CArrayPtrFlat<CSmsNumber>& CSmsHeader::Recipients()

   207 	{

   208 	return iRecipients;

   209 	}

   211 /**

   212 Gets the SMS stack representation of the message.

   214 @return

   215 The SMS stack representation of the message

   217 @see	CSmsMessage

   218 */

   219 inline CSmsMessage& CSmsHeader::Message()

   220 	{

   221 	return *iMessage;

   222 	}

   224 /**

   225 Gets the (const) SMS stack representation of the message.

   227 @return

   228 The const SMS stack representation of the message

   229 */

   230 inline const CSmsMessage& CSmsHeader::Message() const

   231 	{

   232 	return *iMessage;

   233 	}

   235 /**

   236 Tests if the message contains a reply path.

   238 @return

   239 A value of True if the message contains a reply path.

   240 */

   241 inline TBool CSmsHeader::ReplyPathProvided() const

   242 	{

   243 	return iFlags & ESmsHeaderReplyPathProvided;

   244 	}

   246 /**

   247 Set the message flag that indicates whether it contains a reply path.

   249 @param	aReplyPathProvided

   250 A value of True to set the flag.

   251 */

   252 inline void CSmsHeader::SetReplyPathProvided(TBool aReplyPathProvided)

   253 	{

   254 	iFlags = (iFlags & ~ESmsHeaderReplyPathProvided) | (aReplyPathProvided ? ESmsHeaderReplyPathProvided : ESmsHeaderNoFlags);

   255 	}

   257 /**

   258 Sets the originator address.

   260 @param	aAddress

   261 The originator address

   262 */

   263 inline void CSmsHeader::SetFromAddressL(const TDesC& aAddress)

   264 	{

   265 	Message().SmsPDU().SetToFromAddressL(aAddress);

   266 	}

   268 /**

   269 Gets the originator address.

   271 Only valid for SMS-DELIVER and SMS-SUBMIT type messages. With any other message

   272 types the returned originator address is empty.

   274 @return

   275 The originator address.

   276 */

   277 inline TPtrC CSmsHeader::FromAddress() const

   278 	{

   279 	switch(Type())

   280 		{

   281 		case(CSmsPDU::ESmsSubmit):

   282 			return Submit().ToFromAddress();

   283 		case(CSmsPDU::ESmsDeliver):

   284 			return Deliver().ToFromAddress();

   285 		default:

   286 			return TPtrC(0,0);

   287 		}

   288 	}

   290 /**

   291 Gets the message's service center address.

   293 This can only be used on SMS-SUBMIT type messages. The message PDU type can be

   294 checked by using the CSmsHeader::Type API.

   296 @return

   297 The Service Center address.

   299 @panic	SMCM	0

   300 The message was not a PDU of type SMS-SUBMIT (debug only).

   302 @see	CSmsHeader::Type

   303 */

   304 inline TPtrC CSmsHeader::ServiceCenterAddress() const

   305 	{

   306 	return Submit().ServiceCenterAddress();

   307 	}

   309 /**

   310 Sets the message's service center address.

   312 This can only be used on SMS-SUBMIT type messages. The message PDU type can be

   313 checked by using the CSmsHeader::Type API.

   316 @param	aAddress

   317 The Service Center address

   319 @panic	SMCM	0

   320 The message was not a PDU of type SMS-SUBMIT (debug only).

   322 @see	CSmsHeader::Type

   323 */

   324 inline void CSmsHeader::SetServiceCenterAddressL(const TDesC& aAddress)

   325 	{

   326 	Submit().SetServiceCenterAddressL(aAddress);

   327 	}

   329 /**

   330 Gets the message's BIO message type identifier.

   332 For non-BIO messages, this is EBioMsgIdNbs.

   334 @return

   335 The BIO message type identifier

   336 */

   337 inline TBioMsgIdType CSmsHeader::BioMsgIdType() const

   338 	{

   339 	return iBioMsgIdType;

   340 	}

   342 /**

   343 Sets the message's BIO message type identifier.

   345 @param	aBioMsgIdType

   346 The BIO message type identifier

   347 */

   348 inline void CSmsHeader::SetBioMsgIdType(TBioMsgIdType aBioMsgIdType)

   349 	{

   350 	iBioMsgIdType = aBioMsgIdType;

   351 	}

   353 /*

   354  *	TMsvSmsEntry

   355  */

   357 /**

   358 Constructor.

   360 @internalTechnology

   361 @released

   362 */

   363 inline TMsvSmsEntry::TMsvSmsEntry()

   364 	{

   365 	}

   367 /**

   368 Copy constuctor.

   370 @param	aEntry

   371 The index entry to copy.

   373 @internalTechnology

   374 @released

   375 */

   376 inline TMsvSmsEntry::TMsvSmsEntry(const TMsvEntry& aEntry)

   377 : TMsvEntry(aEntry)

   378 	{

   379 	}

   381 /**

   382 Sets the User Prompt Indicator flag.

   384 @param	aUPI

   385 A value of True to set the flag.

   387 @internalTechnology

   388 @released

   389 */

   390 inline void TMsvSmsEntry::SetUserPromptIndicator(TBool aUPI)

   391 	{

   392 	(aUPI) ? (iMtmData2 |= EMsvSmsEntryUserPromptIndicator) : (iMtmData2 &= ~EMsvSmsEntryUserPromptIndicator);

   393 	}

   395 /**

   396 Gets the User Prompt Indicator flag.

   398 @return

   399 A value of True if the User Prompt Indicator flag is.

   401 @internalTechnology

   402 @released

   403 */

   404 inline TBool TMsvSmsEntry::UserPromptIndicator() const

   405 	{

   406 	return (iMtmData2 & EMsvSmsEntryUserPromptIndicator);

   407 	}

   409 /**

   410 Gets the Protocol Identifier data.

   412 @return

   413 The Protocol Identifier data.

   415 @internalTechnology

   416 @released

   417 */

   418 inline TUint8 TMsvSmsEntry::ProtocolIdentifier() const

   419 	{

   420 	return STATIC_CAST(TUint8, iMtmData2 & EMsvSmsEntryProtocolIdentifier);

   421 	}

   423 /**

   424 Sets the Protocol Identifier data.

   426 @param	aPID

   427 The Protocol Identifier data.

   429 @internalTechnology

   430 @released

   431 */

   432 inline void TMsvSmsEntry::SetProtocolIdentifier(TSmsProtocolIdentifier aPID)

   433 	{

   434 	SetProtocolIdentifier(STATIC_CAST(TUint8, aPID));

   435 	}

   437 /**

   438 Sets the Protocol Identifier data.

   440 @param	aPID

   441 The Protocol Identifier data.

   443 @internalTechnology

   444 @released

   445 */

   446 inline void TMsvSmsEntry::SetProtocolIdentifier(TUint8 aPID)

   447 	{

   448 	iMtmData2 = (iMtmData2 & ~EMsvSmsEntryProtocolIdentifier) | (aPID & EMsvSmsEntryProtocolIdentifier);

   449 	}

   451 /**

   452 Sets the SMS class data and defined flag.

   454 @param	aClassDefined

   455 A value of True to set the SMS class data defined flag.

   457 @param	aClass

   458 The SMS class data.

   460 @internalTechnology

   461 @released

   462 */

   463 inline void TMsvSmsEntry::SetClass(TBool aClassDefined, TSmsDataCodingScheme::TSmsClass aClass)

   464 	{

   465 	aClassDefined ? (iMtmData2 |= EMsvSmsEntryClassDefined) : (iMtmData2 &= ~EMsvSmsEntryClassDefined);

   466 	iMtmData2 = (iMtmData2 & ~EMsvSmsEntryClass) | ((aClass << EMsvSmsEntryClassShift) & EMsvSmsEntryClass);

   467 	}

   469 /**

   470 Gets the SMS class data and defined flag.

   472 @param	aClass

   473 An output argument with the SMS class data.

   475 @return

   476 A value of True if the SMS class data defined flag is set.

   478 @internalTechnology

   479 @released

   480 */

   481 inline TBool TMsvSmsEntry::Class(TSmsDataCodingScheme::TSmsClass& aClass) const

   482 	{

   483 	aClass = STATIC_CAST(TSmsDataCodingScheme::TSmsClass, ((iMtmData2 & EMsvSmsEntryClass) >> EMsvSmsEntryClassShift));

   484 	return iMtmData2 & EMsvSmsEntryClassDefined;

   485 	}

author	William Roberts <williamr@symbian.org>
	Tue, 16 Mar 2010 16:12:26 +0000
branch	Symbian2
changeset 2	2fe1408b6811
permissions	-rw-r--r--