epoc32/include/smsuset.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) 1999-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
// contains the implementation of the inline function the TSmsSettings class
williamr@2
    15
// used to get and set the SMS settings
williamr@2
    16
// 
williamr@2
    17
//
williamr@2
    18
williamr@2
    19
/**
williamr@2
    20
 @file
williamr@2
    21
 
williamr@2
    22
 Gets the time-out value.
williamr@2
    23
 
williamr@2
    24
 @return Time-out value 
williamr@2
    25
 
williamr@2
    26
*/
williamr@2
    27
inline const TTimeIntervalMicroSeconds32& TSmsSettings::Timeout() const
williamr@4
    28
    {
williamr@4
    29
    return iTimeoutMicroSeconds32;
williamr@4
    30
    }
williamr@2
    31
williamr@2
    32
/**
williamr@2
    33
 *  Sets the time-out value.
williamr@2
    34
 *  
williamr@2
    35
 *  @param aTimeout Time-out value 
williamr@2
    36
 */
williamr@2
    37
inline void TSmsSettings::SetTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
williamr@4
    38
    {
williamr@4
    39
    iTimeoutMicroSeconds32=aTimeout;
williamr@4
    40
    }
williamr@2
    41
williamr@2
    42
/**
williamr@2
    43
 *  Gets the maximum number of attempts to send an SMS.
williamr@2
    44
 *  
williamr@2
    45
 *  @return Maximum number of attempts to send a SMS 
williamr@2
    46
 */
williamr@2
    47
inline TInt TSmsSettings::SendTryLimit() const
williamr@4
    48
    {
williamr@4
    49
    return iSendTryLimit;
williamr@4
    50
    }
williamr@2
    51
williamr@2
    52
/**
williamr@2
    53
 *  Sets the maximum number of attempts to send an SMS.
williamr@2
    54
 *  
williamr@2
    55
 *  @param aLimit Maximum number of attempts to send a SMS 
williamr@2
    56
 */
williamr@2
    57
inline void TSmsSettings::SetSendTryLimit(TInt aLimit)
williamr@4
    58
    {
williamr@4
    59
    iSendTryLimit=aLimit;
williamr@4
    60
    }
williamr@2
    61
williamr@2
    62
/**
williamr@2
    63
 *  Gets whether the PDU can be deleted from the SIM.
williamr@2
    64
 *  
williamr@2
    65
 *  @return True if the PDU can be deleted from the SIM 
williamr@2
    66
 */
williamr@2
    67
inline TBool TSmsSettings::DeletePDUsFromSIM() const
williamr@4
    68
    {
williamr@4
    69
    return iFlags&ESmsFlagDeletePDUsFromSIM;
williamr@4
    70
    }
williamr@2
    71
williamr@2
    72
/**
williamr@2
    73
 *  Sets whether the PDU can be deleted from the SIM.
williamr@2
    74
 *  
williamr@2
    75
 *  @param aDelete True if the PDU can be deleted from the SIM 
williamr@2
    76
 */
williamr@2
    77
inline void TSmsSettings::SetDeletePDUsFromSIM(TBool aDelete)
williamr@4
    78
    {
williamr@4
    79
    iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromSIM: iFlags&(~ESmsFlagDeletePDUsFromSIM);
williamr@4
    80
    }
williamr@2
    81
williamr@2
    82
/**
williamr@2
    83
 *  Gets whether the PDU can be deleted from the phone store.
williamr@2
    84
 *  
williamr@2
    85
 *  @return True if the PDU can be deleted from the phone store 
williamr@2
    86
 */
williamr@2
    87
inline TBool TSmsSettings::DeletePDUsFromPhoneStores() const
williamr@4
    88
    {
williamr@4
    89
    return iFlags&ESmsFlagDeletePDUsFromPhoneStores;
williamr@4
    90
    }
williamr@2
    91
williamr@2
    92
/**
williamr@2
    93
 *  Sets whether the PDU can be deleted from the phone store.
williamr@2
    94
 *  
williamr@2
    95
 *  @param aDelete True if the PDU can be deleted from phone store 
williamr@2
    96
 */
williamr@2
    97
inline void TSmsSettings::SetDeletePDUsFromPhoneStores(TBool aDelete)
williamr@4
    98
    {
williamr@4
    99
    iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromPhoneStores: iFlags&(~ESmsFlagDeletePDUsFromPhoneStores);
williamr@4
   100
    }
williamr@2
   101
williamr@2
   102
/**
williamr@2
   103
 *  Gets whether the PDU can be deleted from the combined store.
williamr@2
   104
 *  
williamr@2
   105
 *  @return True if the PDU can be deleted from the combined store 
williamr@2
   106
 */
williamr@2
   107
inline TBool TSmsSettings::DeletePDUsFromCombinedStores() const
williamr@4
   108
    {
williamr@4
   109
    return iFlags&ESmsFlagDeletePDUsFromCombinedStores;
williamr@4
   110
    }
williamr@2
   111
williamr@2
   112
/**
williamr@2
   113
 *  Sets whether the PDU can be deleted from the combined store.
williamr@2
   114
 *  
williamr@2
   115
 *  @param aDelete True if the PDU can be deleted from the combined store 
williamr@2
   116
 */
williamr@2
   117
inline void TSmsSettings::SetDeletePDUsFromCombinedStores(TBool aDelete)
williamr@4
   118
    {
williamr@4
   119
    iFlags=aDelete? iFlags|ESmsFlagDeletePDUsFromCombinedStores: iFlags&(~ESmsFlagDeletePDUsFromCombinedStores);
williamr@4
   120
    }
williamr@2
   121
williamr@2
   122
/**
williamr@2
   123
 *  Gets the value of the Reassembly store life time.
williamr@2
   124
 *  
williamr@2
   125
 *  @return Reassembly store life time 
williamr@2
   126
 */
williamr@2
   127
inline const TTimeIntervalMinutes& TSmsSettings::ReassemblyLifetime() const
williamr@4
   128
    {
williamr@4
   129
    return iReassemblyLifetime;
williamr@4
   130
    }
williamr@2
   131
williamr@2
   132
/**
williamr@2
   133
 *  Sets the value of the Reassembly store life time.
williamr@2
   134
 *  
williamr@2
   135
 *  @param aReassemblyLifetime Reassembly store life time 
williamr@2
   136
 */
williamr@2
   137
inline void TSmsSettings::SetReassemblyLifetime(const TTimeIntervalMinutes& aReassemblyLifetime)
williamr@4
   138
    {
williamr@4
   139
    iReassemblyLifetime=aReassemblyLifetime;
williamr@4
   140
    }
williamr@2
   141
williamr@2
   142
/**
williamr@2
   143
 *  Gets the value of the segmentation store multiplier.
williamr@2
   144
 *  
williamr@2
   145
 *  @return Segmentation store multiplier 
williamr@2
   146
 */
williamr@2
   147
inline TInt TSmsSettings::KSegmentationLifetimeMultiplier() const
williamr@4
   148
    {
williamr@4
   149
    return iKSegmentationLifetimeMultiplier;
williamr@4
   150
    }
williamr@2
   151
williamr@2
   152
/**
williamr@2
   153
 *  Sets the value of the segmentation store multiplier.
williamr@2
   154
 *  
williamr@2
   155
 *  @param aKSegmentationLifetimeMultiplier Segmentation store multiplier 
williamr@2
   156
 */
williamr@2
   157
inline void TSmsSettings::SetKSegmentationLifetimeMultiplier(TInt aKSegmentationLifetimeMultiplier)
williamr@4
   158
    {
williamr@4
   159
    iKSegmentationLifetimeMultiplier=aKSegmentationLifetimeMultiplier;
williamr@4
   160
    }
williamr@2
   161
williamr@2
   162
/**
williamr@2
   163
 *  Gets the value of the modem initialisation timeout duration.
williamr@2
   164
 *  
williamr@2
   165
 *  @return Modem initialisation timeout duration 
williamr@2
   166
 */
williamr@2
   167
inline const TTimeIntervalMicroSeconds32& TSmsSettings::ModemInitializationTimeout() const
williamr@4
   168
    {
williamr@4
   169
    return iModemInitializationTimeoutMicroSeconds32;
williamr@4
   170
    }
williamr@2
   171
williamr@2
   172
/**
williamr@2
   173
 *  Sets the value of the modem initialisation timeout duration.
williamr@2
   174
 *  
williamr@2
   175
 *  @param aTimeout Modem initialisation timeout duration 
williamr@2
   176
 */
williamr@2
   177
inline void TSmsSettings::SetModemInitializationTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
williamr@4
   178
    {
williamr@4
   179
    iModemInitializationTimeoutMicroSeconds32=aTimeout;
williamr@4
   180
    }
williamr@2
   181
williamr@2
   182
/**
williamr@2
   183
 *  Gets the Send Try Timeout value
williamr@2
   184
 *  
williamr@2
   185
 *  @return Time-out value
williamr@2
   186
 */
williamr@2
   187
inline const TTimeIntervalMicroSeconds32& TSmsSettings::SendTryTimeout() const
williamr@4
   188
    {
williamr@4
   189
    return iSendTryTimeoutMicroSeconds32;
williamr@4
   190
    }
williamr@2
   191
williamr@2
   192
/**
williamr@2
   193
 *  Sets the Send Try Timeout value.
williamr@2
   194
 *  
williamr@2
   195
 *  @param aTimeout Time-out value
williamr@2
   196
 */
williamr@2
   197
inline void TSmsSettings::SetSendTryTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
williamr@4
   198
    {
williamr@4
   199
    iSendTryTimeoutMicroSeconds32=aTimeout;
williamr@4
   200
    }
williamr@2
   201
williamr@2
   202
/**
williamr@2
   203
 *  Gets the Boot Timer Timeout value
williamr@2
   204
 *  
williamr@2
   205
 *  @return Boot Timer Time-out value
williamr@2
   206
 */
williamr@2
   207
inline const TTimeIntervalMicroSeconds32& TSmsSettings::BootTimerTimeout()
williamr@2
   208
    {
williamr@2
   209
    return iBootTimerTimeout32;
williamr@2
   210
    }
williamr@2
   211
williamr@2
   212
/**
williamr@2
   213
 *  Sets the Boot Timer Timeout value
williamr@2
   214
 *  
williamr@2
   215
 *  @param aTimeout Time-out value 
williamr@2
   216
 */
williamr@2
   217
inline void TSmsSettings::SetBootTimerTimeout(const TTimeIntervalMicroSeconds32& aTimeout)
williamr@2
   218
    {
williamr@2
   219
    iBootTimerTimeout32 = aTimeout;
williamr@2
   220
    }