s57_dictionary_interface.h

Go to the documentation of this file.

#ifndef SDK_S57_DICTIONARY_INTERFACE_H_
#define SDK_S57_DICTIONARY_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 SDKUInt32 S57AttributeCode;    
typedef SDKString S57AttributeName;    
typedef SDKString S57AttributeAcronym; 
typedef wchar_t   S57AttributeType;    
typedef SDKString S57AttributeClass;
 
static const S57AttributeType kS57AttributeType_Enumerated  = L'E';
static const S57AttributeType kS57AttributeType_List        = L'L';
static const S57AttributeType kS57AttributeType_Float       = L'F';
static const S57AttributeType kS57AttributeType_Integer     = L'I';
static const S57AttributeType kS57AttributeType_CodedString = L'A';
static const S57AttributeType kS57AttributeType_FreeText    = L'S';
 
static const wchar_t kS57AttrClass_FeatureObjectAttributes[] = 
  L"Feature object attributes";           
static const wchar_t kS57AttrClass_NationalLanguageAttributes[] = 
  L"National language attributes";        
static const wchar_t kS57AttrClass_SpatialAndMetaObjectAttributes[] = 
  L"Spatial and meta object attributes";  
  
class IS57Attribute;
typedef sdk::SDKRefPtr<IS57Attribute> S57AttributeSP;
 
class IS57Attribute : public sdk::ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE GetCode(S57AttributeCode& code) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetName(S57AttributeName& name) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetAcronym(S57AttributeAcronym& acronym) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetType(S57AttributeType& type) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetClass(S57AttributeClass& cls) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IS57Attribute)
  SDK_END_INTERFACE(IS57Attribute)
};
SDK_DECLARE_IID(IS57Attribute)
 
class IS57AttributesIterator;
typedef sdk::SDKRefPtr<IS57AttributesIterator> S57AttributesIteratorSP;
 
class IS57AttributesIterator : public sdk::ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Next(S57AttributeSP& attribute) throw() = 0;
 
  SDK_IMPLEMENT_IID(IS57AttributesIterator)
  SDK_END_INTERFACE(IS57AttributesIterator)
};
SDK_DECLARE_IID(IS57AttributesIterator)
 
typedef SDKUInt32 S57FOClassCode;       
typedef SDKString S57FOClassName;       
typedef SDKString S57FOClassAcronym;    
typedef SDKUInt32 S57FOClassPrimitives; 
typedef SDKString S57FOClassType;       
 
static const S57FOClassPrimitives kS57FOClassPrimitive_Point = 1; 
static const S57FOClassPrimitives kS57FOClassPrimitive_Line  = 2; 
static const S57FOClassPrimitives kS57FOClassPrimitive_Area  = 4; 
 
static const wchar_t kS57FOClassType_GeoObjectClasses[] = 
  L"Geo object classes";           
static const wchar_t kS57FOClassType_MetaObjectClasses[] = 
  L"Meta object classes";          
static const wchar_t kS57FOClassType_CollectionObjectClasses[] = 
  L"Collection object classes";    
static const wchar_t kS57FOClassType_CartographicObjectClasses[] = 
  L"Cartographic object classes";  
  
class IS57FOClass;
typedef sdk::SDKRefPtr<IS57FOClass> S57FOClassSP;
 
class IS57FOClass : public sdk::ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE GetCode(
    S57FOClassCode& code) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetName(
    S57FOClassName& name) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetAcronym(
    S57FOClassAcronym& acronym) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetPrimitives(
    S57FOClassPrimitives& type) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetType(
    S57AttributeClass& cls) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetAttributesSubsetA(
    S57AttributesIteratorSP& iterator) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetAttributesSubsetB(
    S57AttributesIteratorSP& iterator) const throw() = 0;
  virtual SDKResult SDK_CALLTYPE GetAttributesSubsetC(
    S57AttributesIteratorSP& iterator) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetAttributesSubsetABC(
    S57AttributesIteratorSP& iterator) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IS57FOClass)
  SDK_END_INTERFACE(IS57FOClass)
};
SDK_DECLARE_IID(IS57FOClass)
 
class IS57FOClassesIterator;
typedef sdk::SDKRefPtr<IS57FOClassesIterator> S57FOClassesIteratorSP;
 
class IS57FOClassesIterator : public sdk::ISDKComponent
{
public:
  virtual SDKResult SDK_CALLTYPE Reset() throw() = 0;
  virtual SDKResult SDK_CALLTYPE Next(S57FOClassSP& fo_class) throw() = 0;
 
  SDK_IMPLEMENT_IID(IS57FOClassesIterator)
  SDK_END_INTERFACE(IS57FOClassesIterator)
};
SDK_DECLARE_IID(IS57FOClassesIterator)
 
class IS57Dictionary;
typedef sdk::SDKRefPtr<IS57Dictionary> S57DictionarySP;
 
class IS57Dictionary : public sdk::ISDKComponent
{
 public:
  virtual SDKResult SDK_CALLTYPE GetAttributeByCode(
    const S57AttributeCode& code,
    S57AttributeSP& attribute) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetAttributeByAcronym(
    const S57AttributeAcronym& acronym,
    S57AttributeSP& attribute) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetAttributesIterator(
    S57AttributesIteratorSP& iterator) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetFOClassByCode(const S57FOClassCode& code,
    S57FOClassSP& fo_class) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetFOClassByAcronym(
    const S57FOClassAcronym& acronym,
    S57FOClassSP& fo_class) const throw() = 0;
 
  virtual SDKResult SDK_CALLTYPE GetFOClassesIterator(
    S57FOClassesIteratorSP& iterator) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IS57Dictionary)
  SDK_END_INTERFACE(IS57Dictionary)
};
SDK_DECLARE_IID(IS57Dictionary)
 
} // namespace s63
} // namespace sdk 
 
#endif // SDK_S57_DICTIONARY_INTERFACE_H_