epoc32/include/smsuset.inl
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     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
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    13 // Description:
    13 // Description:
    14 // contains the implementation of the inline function the TSmsSettings class
    14 // contains the implementation of the inline function the TSmsSettings class
    15 // used to get and set the SMS settings
    15 // used to get and set the SMS settings
    16 // 
    16 // 
    17 //
    17 //
    18 
       
    19 
       
    20 
       
    21 
    18 
    22 /**
    19 /**
    23  @file
    20  @file
    24  
    21  
    25  Gets the time-out value.
    22  Gets the time-out value.
    26  
    23  
    27  @return Time-out value 
    24  @return Time-out value 
    28  
    25  
    29 */
    26 */
    30 inline const TTimeIntervalMicroSeconds32& TSmsSettings::Timeout() const
    27 inline const TTimeIntervalMicroSeconds32& TSmsSettings::Timeout() const
    31 	{
    28     {
    32 	return iTimeoutMicroSeconds32;
    29     return iTimeoutMicroSeconds32;
    33 	}
    30     }
    34 
       
    35 
    31 
    36 /**
    32 /**
    37  *  Sets the time-out value.
    33  *  Sets the time-out value.
    38  *  
    34  *  
    39  *  @param aTimeout Time-out value 
    35  *  @param aTimeout Time-out value 
    40  */
    36  */
    41 inline void TSmsSettings::SetTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
    37 inline void TSmsSettings::SetTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
    42 	{
    38     {
    43 	iTimeoutMicroSeconds32=aTimeout;
    39     iTimeoutMicroSeconds32=aTimeout;
    44 	}
    40     }
    45 
       
    46 
    41 
    47 /**
    42 /**
    48  *  Gets the maximum number of attempts to send an SMS.
    43  *  Gets the maximum number of attempts to send an SMS.
    49  *  
    44  *  
    50  *  @return Maximum number of attempts to send a SMS 
    45  *  @return Maximum number of attempts to send a SMS 
    51  */
    46  */
    52 inline TInt TSmsSettings::SendTryLimit() const
    47 inline TInt TSmsSettings::SendTryLimit() const
    53 	{
    48     {
    54 	return iSendTryLimit;
    49     return iSendTryLimit;
    55 	}
    50     }
    56 
       
    57 
    51 
    58 /**
    52 /**
    59  *  Sets the maximum number of attempts to send an SMS.
    53  *  Sets the maximum number of attempts to send an SMS.
    60  *  
    54  *  
    61  *  @param aLimit Maximum number of attempts to send a SMS 
    55  *  @param aLimit Maximum number of attempts to send a SMS 
    62  */
    56  */
    63 inline void TSmsSettings::SetSendTryLimit(TInt aLimit)
    57 inline void TSmsSettings::SetSendTryLimit(TInt aLimit)
    64 	{
    58     {
    65 	iSendTryLimit=aLimit;
    59     iSendTryLimit=aLimit;
    66 	}
    60     }
    67 
       
    68 
    61 
    69 /**
    62 /**
    70  *  Gets whether the PDU can be deleted from the SIM.
    63  *  Gets whether the PDU can be deleted from the SIM.
    71  *  
    64  *  
    72  *  @return True if the PDU can be deleted from the SIM 
    65  *  @return True if the PDU can be deleted from the SIM 
    73  */
    66  */
    74 inline TBool TSmsSettings::DeletePDUsFromSIM() const
    67 inline TBool TSmsSettings::DeletePDUsFromSIM() const
    75 	{
    68     {
    76 	return iFlags&ESmsFlagDeletePDUsFromSIM;
    69     return iFlags&ESmsFlagDeletePDUsFromSIM;
    77 	}
    70     }
    78 
       
    79 
    71 
    80 /**
    72 /**
    81  *  Sets whether the PDU can be deleted from the SIM.
    73  *  Sets whether the PDU can be deleted from the SIM.
    82  *  
    74  *  
    83  *  @param aDelete True if the PDU can be deleted from the SIM 
    75  *  @param aDelete True if the PDU can be deleted from the SIM 
    84  */
    76  */
    85 inline void TSmsSettings::SetDeletePDUsFromSIM(TBool aDelete)
    77 inline void TSmsSettings::SetDeletePDUsFromSIM(TBool aDelete)
    86 	{
    78     {
    87 	iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromSIM: iFlags&(~ESmsFlagDeletePDUsFromSIM);
    79     iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromSIM: iFlags&(~ESmsFlagDeletePDUsFromSIM);
    88 	}
    80     }
    89 
       
    90 
    81 
    91 /**
    82 /**
    92  *  Gets whether the PDU can be deleted from the phone store.
    83  *  Gets whether the PDU can be deleted from the phone store.
    93  *  
    84  *  
    94  *  @return True if the PDU can be deleted from the phone store 
    85  *  @return True if the PDU can be deleted from the phone store 
    95  */
    86  */
    96 inline TBool TSmsSettings::DeletePDUsFromPhoneStores() const
    87 inline TBool TSmsSettings::DeletePDUsFromPhoneStores() const
    97 	{
    88     {
    98 	return iFlags&ESmsFlagDeletePDUsFromPhoneStores;
    89     return iFlags&ESmsFlagDeletePDUsFromPhoneStores;
    99 	}
    90     }
   100 
       
   101 
    91 
   102 /**
    92 /**
   103  *  Sets whether the PDU can be deleted from the phone store.
    93  *  Sets whether the PDU can be deleted from the phone store.
   104  *  
    94  *  
   105  *  @param aDelete True if the PDU can be deleted from phone store 
    95  *  @param aDelete True if the PDU can be deleted from phone store 
   106  */
    96  */
   107 inline void TSmsSettings::SetDeletePDUsFromPhoneStores(TBool aDelete)
    97 inline void TSmsSettings::SetDeletePDUsFromPhoneStores(TBool aDelete)
   108 	{
    98     {
   109 	iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromPhoneStores: iFlags&(~ESmsFlagDeletePDUsFromPhoneStores);
    99     iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromPhoneStores: iFlags&(~ESmsFlagDeletePDUsFromPhoneStores);
   110 	}
   100     }
   111 
       
   112 
   101 
   113 /**
   102 /**
   114  *  Gets whether the PDU can be deleted from the combined store.
   103  *  Gets whether the PDU can be deleted from the combined store.
   115  *  
   104  *  
   116  *  @return True if the PDU can be deleted from the combined store 
   105  *  @return True if the PDU can be deleted from the combined store 
   117  */
   106  */
   118 inline TBool TSmsSettings::DeletePDUsFromCombinedStores() const
   107 inline TBool TSmsSettings::DeletePDUsFromCombinedStores() const
   119 	{
   108     {
   120 	return iFlags&ESmsFlagDeletePDUsFromCombinedStores;
   109     return iFlags&ESmsFlagDeletePDUsFromCombinedStores;
   121 	}
   110     }
   122 
       
   123 
   111 
   124 /**
   112 /**
   125  *  Sets whether the PDU can be deleted from the combined store.
   113  *  Sets whether the PDU can be deleted from the combined store.
   126  *  
   114  *  
   127  *  @param aDelete True if the PDU can be deleted from the combined store 
   115  *  @param aDelete True if the PDU can be deleted from the combined store 
   128  */
   116  */
   129 inline void TSmsSettings::SetDeletePDUsFromCombinedStores(TBool aDelete)
   117 inline void TSmsSettings::SetDeletePDUsFromCombinedStores(TBool aDelete)
   130 	{
   118     {
   131 	iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromCombinedStores: iFlags&(~ESmsFlagDeletePDUsFromCombinedStores);
   119     iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromCombinedStores: iFlags&(~ESmsFlagDeletePDUsFromCombinedStores);
   132 	}
   120     }
   133 
       
   134 
   121 
   135 /**
   122 /**
   136  *  Gets the value of the Reassembly store life time.
   123  *  Gets the value of the Reassembly store life time.
   137  *  
   124  *  
   138  *  @return Reassembly store life time 
   125  *  @return Reassembly store life time 
   139  */
   126  */
   140 inline const TTimeIntervalMinutes& TSmsSettings::ReassemblyLifetime() const
   127 inline const TTimeIntervalMinutes& TSmsSettings::ReassemblyLifetime() const
   141 	{
   128     {
   142 	return iReassemblyLifetime;
   129     return iReassemblyLifetime;
   143 	}
   130     }
   144 
       
   145 
   131 
   146 /**
   132 /**
   147  *  Sets the value of the Reassembly store life time.
   133  *  Sets the value of the Reassembly store life time.
   148  *  
   134  *  
   149  *  @param aReassemblyLifetime Reassembly store life time 
   135  *  @param aReassemblyLifetime Reassembly store life time 
   150  */
   136  */
   151 inline void TSmsSettings::SetReassemblyLifetime(const TTimeIntervalMinutes& aReassemblyLifetime)
   137 inline void TSmsSettings::SetReassemblyLifetime(const TTimeIntervalMinutes& aReassemblyLifetime)
   152 	{
   138     {
   153 	iReassemblyLifetime=aReassemblyLifetime;
   139     iReassemblyLifetime=aReassemblyLifetime;
   154 	}
   140     }
   155 
       
   156 
   141 
   157 /**
   142 /**
   158  *  Gets the value of the segmentation store multiplier.
   143  *  Gets the value of the segmentation store multiplier.
   159  *  
   144  *  
   160  *  @return Segmentation store multiplier 
   145  *  @return Segmentation store multiplier 
   161  */
   146  */
   162 inline TInt TSmsSettings::KSegmentationLifetimeMultiplier() const
   147 inline TInt TSmsSettings::KSegmentationLifetimeMultiplier() const
   163 	{
   148     {
   164 	return iKSegmentationLifetimeMultiplier;
   149     return iKSegmentationLifetimeMultiplier;
   165 	}
   150     }
   166 
       
   167 
   151 
   168 /**
   152 /**
   169  *  Sets the value of the segmentation store multiplier.
   153  *  Sets the value of the segmentation store multiplier.
   170  *  
   154  *  
   171  *  @param aKSegmentationLifetimeMultiplier Segmentation store multiplier 
   155  *  @param aKSegmentationLifetimeMultiplier Segmentation store multiplier 
   172  */
   156  */
   173 inline void TSmsSettings::SetKSegmentationLifetimeMultiplier(TInt aKSegmentationLifetimeMultiplier)
   157 inline void TSmsSettings::SetKSegmentationLifetimeMultiplier(TInt aKSegmentationLifetimeMultiplier)
   174 	{
   158     {
   175 	iKSegmentationLifetimeMultiplier=aKSegmentationLifetimeMultiplier;
   159     iKSegmentationLifetimeMultiplier=aKSegmentationLifetimeMultiplier;
   176 	}
   160     }
   177 
       
   178 
   161 
   179 /**
   162 /**
   180  *  Gets the value of the modem initialisation timeout duration.
   163  *  Gets the value of the modem initialisation timeout duration.
   181  *  
   164  *  
   182  *  @return Modem initialisation timeout duration 
   165  *  @return Modem initialisation timeout duration 
   183  */
   166  */
   184 inline const TTimeIntervalMicroSeconds32& TSmsSettings::ModemInitializationTimeout() const
   167 inline const TTimeIntervalMicroSeconds32& TSmsSettings::ModemInitializationTimeout() const
   185 	{
   168     {
   186 	return iModemInitializationTimeoutMicroSeconds32;
   169     return iModemInitializationTimeoutMicroSeconds32;
   187 	}
   170     }
   188 
       
   189 
   171 
   190 /**
   172 /**
   191  *  Sets the value of the modem initialisation timeout duration.
   173  *  Sets the value of the modem initialisation timeout duration.
   192  *  
   174  *  
   193  *  @param aTimeout Modem initialisation timeout duration 
   175  *  @param aTimeout Modem initialisation timeout duration 
   194  */
   176  */
   195 inline void TSmsSettings::SetModemInitializationTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   177 inline void TSmsSettings::SetModemInitializationTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   196 	{
   178     {
   197 	iModemInitializationTimeoutMicroSeconds32=aTimeout;
   179     iModemInitializationTimeoutMicroSeconds32=aTimeout;
   198 	}
   180     }
   199 
       
   200 
   181 
   201 /**
   182 /**
   202  *  Gets the Send Try Timeout value
   183  *  Gets the Send Try Timeout value
   203  *  
   184  *  
   204  *  @return Time-out value
   185  *  @return Time-out value
   205  */
   186  */
   206 inline const TTimeIntervalMicroSeconds32& TSmsSettings::SendTryTimeout() const
   187 inline const TTimeIntervalMicroSeconds32& TSmsSettings::SendTryTimeout() const
   207 	{
   188     {
   208 	return iSendTryTimeoutMicroSeconds32;
   189     return iSendTryTimeoutMicroSeconds32;
   209 	}
   190     }
   210 
       
   211 
   191 
   212 /**
   192 /**
   213  *  Sets the Send Try Timeout value.
   193  *  Sets the Send Try Timeout value.
   214  *  
   194  *  
   215  *  @param aTimeout Time-out value
   195  *  @param aTimeout Time-out value
   216  */
   196  */
   217 inline void TSmsSettings::SetSendTryTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   197 inline void TSmsSettings::SetSendTryTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
   218 	{
   198     {
   219 	iSendTryTimeoutMicroSeconds32=aTimeout;
   199     iSendTryTimeoutMicroSeconds32=aTimeout;
   220 	}
   200     }
   221 
       
   222 
   201 
   223 /**
   202 /**
   224  *  Gets the Boot Timer Timeout value
   203  *  Gets the Boot Timer Timeout value
   225  *  
   204  *  
   226  *  @return Boot Timer Time-out value
   205  *  @return Boot Timer Time-out value
   228 inline const TTimeIntervalMicroSeconds32& TSmsSettings::BootTimerTimeout()
   207 inline const TTimeIntervalMicroSeconds32& TSmsSettings::BootTimerTimeout()
   229     {
   208     {
   230     return iBootTimerTimeout32;
   209     return iBootTimerTimeout32;
   231     }
   210     }
   232 
   211 
   233 
       
   234 /**
   212 /**
   235  *  Sets the Boot Timer Timeout value
   213  *  Sets the Boot Timer Timeout value
   236  *  
   214  *  
   237  *  @param aTimeout Time-out value 
   215  *  @param aTimeout Time-out value 
   238  */
   216  */