s63_products_file_interface.h

 
#ifndef SDK_S63_PRODUCTS_FILE_INTERFACE_H_
#define SDK_S63_PRODUCTS_FILE_INTERFACE_H_
#pragma once
 
#include <base/inc/platform.h>
#include <base/inc/sdk_component_base.h>
#include <base/inc/interfaces/properties/properties_interface.h>
#include <base/inc/interfaces/collection/collection_interface.h>
#include <datalayer/inc/s63_base/s63_cell_permits_interface.h>
 
namespace sdk {
namespace s63 {
 
FWD_DECL_INTERFACE(IS63ProductsFileRecord);
FWD_DECL_INTERFACE(IS63ProductsFileRecordsEnum);
FWD_DECL_INTERFACE(IS63ProductsFile);
 
typedef enum ProductsFileRecordFields
{
  kProductsFileRecordField_IsOfficial = 0,                     
  kProductsFileRecordField_CellName,                           
  kProductsFileRecordField_RecordString,                       
  
  kProductsFileRecordField_ProductName,                        
  kProductsFileRecordField_BaseCellIssueDate,                  
  kProductsFileRecordField_BaseCellEdition,                    
  kProductsFileRecordField_IssueDateLatestUpdate,              
  kProductsFileRecordField_LatestUpdateNumber,                 
  kProductsFileRecordField_FileSize,                           
  kProductsFileRecordField_CellLimitSouthernmostLatitude,      
  kProductsFileRecordField_CellLimitWesternmostLongitude,      
  kProductsFileRecordField_CellLimitNothernmostLatitude,       
  kProductsFileRecordField_CellLimitEasternmostLongitude,      
  kProductsFileRecordField_Compression,                        
  kProductsFileRecordField_Encryption,                         
  kProductsFileRecordField_BaseCellUpdateNumber,               
  kProductsFileRecordField_LastUpdateNumberForPreviousEdition, 
  kProductsFileRecordField_BaseCellLocation,                   
  kProductsFileRecordField_CancelledCellReplacement,           
} ProductsFileRecordFields;
 
typedef enum ProductsFileVersion
{
  kProductsFileVersion_Unknown  = 0, 
  kProductsFileVersion_Version1 = 1, 
  kProductsFileVersion_Version2 = 2, 
} ProductsFileVersion;
 
typedef enum ProductsFileContentType
{
  kProductsFileContentType_Unknown = 0, 
  kProductsFileContentType_Partial = 1, 
  kProductsFileContentType_Full    = 2, 
} ProductsFileContentType;
 
typedef enum S63ProductsFileProps
{
  kS63ProductsFileProp_RecordsCount = 0, 
 
  kS63ProductsFileProp_DateTime     = 1, 
 
  kS63ProductsFileProp_FileVersion  = 2, 
 
  kS63ProductsFileProp_ContentType  = 3, 
 
} S63ProductsFileProps;
 
class IS63ProductsFileRecord : public sdk::ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetFieldValue(
    const ProductsFileRecordFields& field_id, SDKAny& field_value) const throw() = 0;
 
  template< typename T >
  SDKResult GetFieldValueT(
    const ProductsFileRecordFields& field_id, T& out) const throw()
  {
    try
    {
      SDK_NAMESPACE::ScopedAny value;
      SDKResult res = GetFieldValue(field_id, value);
      if (SDK_FAILED(res))
        return res;
      if (ANY_IS_EMPTY(&value))
        return kSDKResult_NotExist;
      return value.GetAs< T >(out)
        ? kSDKResult_Succeeded : kSDKResult_InvalidArgument;
    }
    catch (...) {}
 
    return kSDKResult_UnknownError;
  }
 
  SDK_IMPLEMENT_IID(IS63ProductsFileRecord)
  SDK_END_INTERFACE(IS63ProductsFileRecord)
};
SDK_DECLARE_IID(IS63ProductsFileRecord)
 
class IS63ProductsFileRecordsEnum : public sdk::ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Next(
    IS63ProductsFileRecordSP& products_file_record) const throw() = 0;
 
  // ALSO CAN IMPLEMENT sdk::ICollectionSDKComponent interface
 
  SDK_IMPLEMENT_IID(IS63ProductsFileRecordsEnum)
  SDK_END_INTERFACE(IS63ProductsFileRecordsEnum)
};
SDK_DECLARE_IID(IS63ProductsFileRecordsEnum)
 
class IS63ProductsFile : public sdk::ISDKProperties
{
public:
  virtual SDKResult SDK_CALLTYPE GetIterator(
    IS63ProductsFileRecordsEnumSP& iterator) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetRecord(
    const CellName& cell_name, IS63ProductsFileRecordSP& record) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IS63ProductsFile)
  SDK_END_INTERFACE(IS63ProductsFile)
};
SDK_DECLARE_IID(IS63ProductsFile)
 
} // namespace s63
} // namespace sdk 
 
#endif // SDK_S63_SERIAL_FILE_INTERFACE_H_