epoc32/include/gsmustor.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.
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
// Implements inline methods for classes TSAREntry and CSARStore
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
#include <s32file.h>
williamr@2
    23
williamr@2
    24
/**
williamr@2
    25
 *  Gets the Reference field.
williamr@2
    26
 *  
williamr@2
    27
 *  @return Concatenation reference 
williamr@2
    28
 */
williamr@2
    29
inline TInt TSAREntry::Reference() const
williamr@2
    30
	{
williamr@2
    31
	return iReference;
williamr@2
    32
	}
williamr@2
    33
williamr@2
    34
williamr@2
    35
/**
williamr@2
    36
 *  Sets the Reference field.
williamr@2
    37
 *  
williamr@2
    38
 *  @param aReference The concatenation reference 
williamr@2
    39
 */
williamr@2
    40
inline void TSAREntry::SetReference(TInt aReference)
williamr@2
    41
	{
williamr@2
    42
	iReference=aReference;
williamr@2
    43
	}
williamr@2
    44
williamr@2
    45
williamr@2
    46
/**
williamr@2
    47
 *  Gets the Total field.
williamr@2
    48
 *  
williamr@2
    49
 *  @return The total number of PDUs in SMS message 
williamr@2
    50
 */
williamr@2
    51
inline TInt TSAREntry::Total() const
williamr@2
    52
	{
williamr@2
    53
	return iTotal;
williamr@2
    54
	}
williamr@2
    55
williamr@2
    56
williamr@2
    57
/**
williamr@2
    58
 *  Sets the total number of PDUs in SMS message
williamr@2
    59
 *  
williamr@2
    60
 *  @param aTotal The total number of PDUs in the message 
williamr@2
    61
 */
williamr@2
    62
inline void TSAREntry::SetTotal(TInt aTotal)
williamr@2
    63
	{
williamr@2
    64
	iTotal=aTotal;
williamr@2
    65
	}
williamr@2
    66
williamr@2
    67
williamr@2
    68
/**
williamr@2
    69
 *  Gets the Count field.
williamr@2
    70
 *  
williamr@2
    71
 *  @return Number of PDUs sent/received 
williamr@2
    72
 */
williamr@2
    73
inline TInt TSAREntry::Count() const
williamr@2
    74
	{
williamr@2
    75
	return iCount;
williamr@2
    76
	}
williamr@2
    77
williamr@2
    78
williamr@2
    79
/**
williamr@2
    80
 *  Sets the Count field.
williamr@2
    81
 *  
williamr@2
    82
 *  @param aCount The number of PDUs sent/received 
williamr@2
    83
 */
williamr@2
    84
inline void TSAREntry::SetCount(TInt aCount)
williamr@2
    85
	{
williamr@2
    86
	iCount=aCount;
williamr@2
    87
	}
williamr@2
    88
williamr@2
    89
williamr@2
    90
/**
williamr@2
    91
 *  Tests if the whole message is sent/received.
williamr@2
    92
 *  
williamr@2
    93
 *  @return True if the whole message is sent/received 
williamr@2
    94
 */
williamr@2
    95
inline TBool TSAREntry::IsComplete() const
williamr@2
    96
	{
williamr@2
    97
	return iCount==iTotal;
williamr@2
    98
	}
williamr@2
    99
williamr@2
   100
williamr@2
   101
/**
williamr@2
   102
 *  Gets the Description1 field: a pointer to the first
williamr@2
   103
 *  32 characters from buffer.
williamr@2
   104
 *  
williamr@2
   105
 *  @return Description1 field 
williamr@2
   106
 */
williamr@2
   107
inline TPtrC TSAREntry::Description1() const
williamr@2
   108
	{
williamr@2
   109
	return iDescription1;
williamr@2
   110
	}
williamr@2
   111
williamr@2
   112
williamr@2
   113
/**
williamr@2
   114
 *  Sets the Description1 field: the first 32 characters in buffer.
williamr@2
   115
 *  
williamr@2
   116
 *  @param aDescription Description1 field 
williamr@2
   117
 */
williamr@2
   118
inline void TSAREntry::SetDescription1(const TDesC& aDescription)
williamr@2
   119
	{
williamr@2
   120
	iDescription1=aDescription;
williamr@2
   121
	}
williamr@2
   122
williamr@2
   123
williamr@2
   124
/**
williamr@2
   125
 *  Gets the Description2 field: a pointer to the original address.
williamr@2
   126
 *  
williamr@2
   127
 *  @return Description2 field 
williamr@2
   128
 */
williamr@2
   129
inline TPtrC TSAREntry::Description2() const
williamr@2
   130
	{
williamr@2
   131
	return iDescription2;
williamr@2
   132
	}
williamr@2
   133
williamr@2
   134
williamr@2
   135
/**
williamr@2
   136
 *  Sets the Description2 field: the original address.
williamr@2
   137
 *  
williamr@2
   138
 *  @param aDescription Description2 field 
williamr@2
   139
 */
williamr@2
   140
inline void TSAREntry::SetDescription2(const TDesC& aDescription)
williamr@2
   141
	{
williamr@2
   142
	iDescription2=aDescription;
williamr@2
   143
	}
williamr@2
   144
williamr@2
   145
williamr@2
   146
/**
williamr@2
   147
 *  Gets the Data3 field.
williamr@2
   148
 *  
williamr@2
   149
 *  @return Data3 field 
williamr@2
   150
 */
williamr@2
   151
inline TInt TSAREntry::Data3() const
williamr@2
   152
	{
williamr@2
   153
	return iData3;
williamr@2
   154
	}
williamr@2
   155
williamr@2
   156
williamr@2
   157
/**
williamr@2
   158
 *  Sets the Data3 field.
williamr@2
   159
 *  
williamr@2
   160
 *  @param aData Data3 field 
williamr@2
   161
 */
williamr@2
   162
inline void TSAREntry::SetData3(TInt aData)
williamr@2
   163
	{
williamr@2
   164
	iData3=aData;
williamr@2
   165
	}
williamr@2
   166
williamr@2
   167
williamr@2
   168
/**
williamr@2
   169
 *  Gets the Time field: the time when this message was sent/received.
williamr@2
   170
 *  
williamr@2
   171
 *  @return Time field 
williamr@2
   172
 */
williamr@2
   173
inline const TTime& TSAREntry::Time() const
williamr@2
   174
	{
williamr@2
   175
	return iTime;
williamr@2
   176
	}
williamr@2
   177
williamr@2
   178
williamr@2
   179
/**
williamr@2
   180
 *  Sets the Time field: the time when this message was sent/received.
williamr@2
   181
 *  
williamr@2
   182
 *  @param aTime Time field 
williamr@2
   183
 */
williamr@2
   184
inline void TSAREntry::SetTime(const TTime& aTime)
williamr@2
   185
	{
williamr@2
   186
	iTime=aTime;
williamr@2
   187
	}
williamr@2
   188
williamr@2
   189
williamr@2
   190
/**
williamr@2
   191
 *  Gets the data stream ID.
williamr@2
   192
 *  
williamr@2
   193
 *  @return Data stream ID 
williamr@2
   194
 */
williamr@2
   195
inline TStreamId TSAREntry::DataStreamId() const
williamr@2
   196
	{
williamr@2
   197
	return iDataStreamId;
williamr@2
   198
	}
williamr@2
   199
williamr@2
   200
williamr@2
   201
/**
williamr@2
   202
 *  Sets the data stream ID.
williamr@2
   203
 *  
williamr@2
   204
 *  @param aStreamId Data stream ID 
williamr@2
   205
 */
williamr@2
   206
inline void TSAREntry::SetDataStreamId(TStreamId aStreamId)
williamr@2
   207
	{
williamr@2
   208
	iDataStreamId=aStreamId;
williamr@2
   209
	}
williamr@2
   210
williamr@2
   211
williamr@2
   212
/**
williamr@2
   213
 *  @return ETrue if this message is deleted
williamr@2
   214
 */
williamr@2
   215
inline TBool TSAREntry::IsDeleted() const
williamr@2
   216
	{
williamr@2
   217
	return iFlags&ESAREntryIsDeleted;
williamr@2
   218
	}
williamr@2
   219
williamr@2
   220
williamr@2
   221
/**
williamr@2
   222
 *  Sets if this message should be marked as deleted
williamr@2
   223
 *  
williamr@2
   224
 *  @param aIsDeleted Set to True to mark a message as deleted
williamr@2
   225
 */
williamr@2
   226
inline void TSAREntry::SetIsDeleted(TBool aIsDeleted)
williamr@2
   227
	{
williamr@2
   228
	iFlags=aIsDeleted?iFlags|ESAREntryIsDeleted: iFlags&(~ESAREntryIsDeleted);
williamr@2
   229
	}
williamr@2
   230
williamr@2
   231
williamr@2
   232
/**
williamr@2
   233
 *  @return ETrue if this message is added
williamr@2
   234
 */
williamr@2
   235
inline TBool TSAREntry::IsAdded() const
williamr@2
   236
	{
williamr@2
   237
	return iFlags&ESAREntryIsAdded;
williamr@2
   238
	}
williamr@2
   239
williamr@2
   240
williamr@2
   241
/**
williamr@2
   242
 *  Sets if this message should be marked as added
williamr@2
   243
 *  
williamr@2
   244
 *  @param aIsDeleted Set to True to mark a message as added
williamr@2
   245
 */
williamr@2
   246
inline void TSAREntry::SetIsAdded(TBool aIsAdded)
williamr@2
   247
	{
williamr@2
   248
	iFlags=aIsAdded?iFlags|ESAREntryIsAdded: iFlags&(~ESAREntryIsAdded);
williamr@2
   249
	}
williamr@2
   250
williamr@2
   251
williamr@2
   252
/**
williamr@2
   253
 *  Gets the file server handle.
williamr@2
   254
 *  
williamr@2
   255
 *  @return File server handle 
williamr@2
   256
 */
williamr@2
   257
inline RFs& CSARStore::FileSession() const
williamr@2
   258
	{
williamr@2
   259
	return iFs;
williamr@2
   260
	}
williamr@2
   261
williamr@2
   262
williamr@2
   263
/**
williamr@2
   264
 *  @return whether it's in transaction
williamr@2
   265
 */
williamr@2
   266
inline TBool CSARStore::InTransaction() const
williamr@2
   267
	{
williamr@2
   268
	return iInTransaction;
williamr@2
   269
	}