s63_cell_permits_interface.h

Go to the documentation of this file.

#ifndef SDK_S63_CELL_PERMITS_INTERFACE_H_
#define SDK_S63_CELL_PERMITS_INTERFACE_H_
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_string_handler.h>
#include <base/inc/sdk_component_interface.h>
#include <base/inc/sdk_ref_ptr.h>
 
namespace sdk {
namespace s63 {
 
typedef SDKUInt8  CellKey[5];                
typedef SDKUInt8  CellName[8];               
typedef SDKTime   CellPermitExpirationDate;  
typedef SDKInt8   CellServiceLevelIndicator; 
typedef SDKUInt32 CellEditionNumber;         
typedef SDKUInt8  DataServerID[2];           
typedef SDKString CellPermitComment;         
 
static const CellServiceLevelIndicator kUndefinedServiceLevelIndicator = -1;
 
static const DataServerID kUndefinedDataserverID = {'?', '?'};
static const SDKUInt16 kPackedUndefinedDataserverID = 0x3f3f;
 
static inline void InitDataServerID(DataServerID& dataserverid) {
  dataserverid[0] = kUndefinedDataserverID[0];
  dataserverid[1] = kUndefinedDataserverID[1];
}
static inline void AssignDataServerID(DataServerID& dataserverid1, 
  const DataServerID& dataserverid2) {
  dataserverid1[0] = dataserverid2[0]; dataserverid1[1] = dataserverid2[1];
}
static inline bool CompareDataServerID(
  const DataServerID& dataserverid1, const DataServerID& dataserverid2) {
  return dataserverid1[0] == dataserverid2[0] 
    && dataserverid1[1] == dataserverid2[1];
}
static inline void UnpackDataServerID(SDKUInt16 packed_dataserverid, 
  DataServerID& dataserverid) {
  dataserverid[0] = static_cast<SDKUInt8>(packed_dataserverid >> 8);
  dataserverid[1] = static_cast<SDKUInt8>(packed_dataserverid & 0xFF);
}
static inline SDKUInt16 PackDataServerID(const DataServerID& dataserverid) {
  SDKUInt16 packed_dataserver_id = dataserverid[1] | dataserverid[0] << 8;
  return packed_dataserver_id;
}
static inline bool IsUndefinedDataServerID(const DataServerID& dataserverid) {
  return (dataserverid[0] == kUndefinedDataserverID[0] && 
    dataserverid[1] == kUndefinedDataserverID[1]);
}
static inline void InitCellKey(CellKey& key) {
  key[0] = 0; key[1] = 0; key[2] = 0; key[3] = 0; key[4] = 0;
}
static inline void AssignCellKey(CellKey& to, const CellKey& from) {
  to[0] = from[0]; to[1] = from[1]; to[2] = from[2]; to[3] = from[3];
  to[4] = from[4];
}
 
FWD_DECL_INTERFACE(IS63CellPermit)
FWD_DECL_INTERFACE(IS63CellPermitsStorage)
FWD_DECL_INTERFACE(IS63CellPermitsIterator)
 
typedef sdk::SDKRefPtr<IS63CellPermitsIterator> S63CellPermitsIteratorSP;
typedef sdk::SDKRefPtr<IS63CellPermitsStorage> S63CellPermitsStorageSP;
typedef sdk::SDKRefPtr<IS63CellPermit> S63CellPermitSP;
 
typedef enum S63CellPermitsFileFormat
{
  kS63CellPermitsFileFormat_Unknown  = 0, 
  kS63CellPermitsFileFormat_Version1 = 1, 
  kS63CellPermitsFileFormat_Version2 = 2, 
} S63CellPermitsFileFormat;
 
typedef enum S63CellPermitsStorageProp
{
  kS63CellPermitsStorageProp_CellPermitsCount                  = 0, 
  kS63CellPermitsStorageProp_PermitsDateTime                   = 1, 
  kS63CellPermitsStorageProp_PermitsFileVersion                = 2, 
  kS63CellPermitsStorageProp_OfficialPermitsStringsIterator    = 3, 
  kS63CellPermitsStorageProp_NonOfficialPermitsStringsIterator = 4, 
} S63CellPermitsStorageProp;
 
class IS63CellPermit : public sdk::ISDKComponent
{
 public:
  virtual SDKResult SDK_CALLTYPE GetCellName(
    CellName& cell_name) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetCellKey1(
    CellKey& cell_key) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetCellKey2(
    CellKey& cell_key) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetExpirationDate(
    CellPermitExpirationDate& exp_date) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetServiceLevelIndicator(
    CellServiceLevelIndicator& service_level_ind) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetCellEditionNumber(
    CellEditionNumber& edition_number) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetDataServerID(
    DataServerID& dataserver_id) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetComment(
    CellPermitComment& cell_permit_comment) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE IsForOfficialCell(
    bool& is_for_official_cell) const throw() = 0;
 
  // IID() method implementation
  SDK_IMPLEMENT_IID(IS63CellPermit)
  SDK_END_INTERFACE(IS63CellPermit)
};
SDK_DECLARE_IID(IS63CellPermit)
 
class IS63CellPermitsIterator : public sdk::ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Next(S63CellPermitSP& cell_permit) throw() = 0;
 
  SDK_IMPLEMENT_IID(IS63CellPermitsIterator)
  SDK_END_INTERFACE(IS63CellPermitsIterator)
};
SDK_DECLARE_IID(IS63CellPermitsIterator)
 
class IS63CellPermitsStorage : public sdk::ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE GetIterator(
    S63CellPermitsIteratorSP& iterator) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetCellPermits(
    const CellName& cell_name, const DataServerID& dataserver_id,
    S63CellPermitsIteratorSP& iterator) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE FindPermits(
    const CellName& cell_name, const DataServerID& dataserver_id) const throw() = 0;
 
 
  SDK_IMPLEMENT_IID(IS63CellPermitsStorage)
  SDK_END_INTERFACE(IS63CellPermitsStorage)
};
SDK_DECLARE_IID(IS63CellPermitsStorage)
 
} // namespace s63
} // namespace sdk 
 
#endif // SDK_S63_CELL_PERMITS_INTERFACE_H_