gdb_feature_catalog.h

Go to the documentation of this file.

#ifndef SDK_GDB_FEATURE_CATALOG_INTERFACE_H_
#define SDK_GDB_FEATURE_CATALOG_INTERFACE_H_
#pragma once
 
#include <base/inc/sdk_any_handler.h>
#include <base/inc/interfaces/enum/enum_interface.h>
#include <datalayer/inc/geodatabase/gdb_const.h>
 
SDK_GDB_BEGIN_NAMESPACE
 
// Classes declared in this file.
FWD_DECL_INTERFACE(IClassCatalogFactory);
FWD_DECL_INTERFACE(IClassCatalog);
FWD_DECL_INTERFACE(IFeatureClassCatalog);
FWD_DECL_INTERFACE(IAttributeClassCatalog);
FWD_DECL_INTERFACE(IClass);
FWD_DECL_INTERFACE(IAttributeClass);
FWD_DECL_INTERFACE(IFeatureClass);
FWD_DECL_INTERFACE(IEnumClassBinding);
FWD_DECL_INTERFACE(IClassBinding);
FWD_DECL_INTERFACE(IEnumClassListedValue);
FWD_DECL_INTERFACE(IClassListedValue);
FWD_DECL_INTERFACE(IEnumClassValue);
FWD_DECL_INTERFACE(IClassValue);
 
static const sdk::Uuid kClassCatalogFactoryCID = "ClassCatalogFactoryCID";
 
class IClassCatalogFactory : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE Open(
    const SDKString& filename,
    IClassCatalog** class_catalog) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE Create(
    const SDKString& filename,
    IClassCatalog** class_catalog) throw() = 0;
 
  SDK_IMPLEMENT_IID(IClassCatalogFactory)
  SDK_END_INTERFACE(IClassCatalogFactory)
};
SDK_DECLARE_IID(IClassCatalogFactory)
 
typedef enum ClassType{
  kClassType_FeatureClass = 0, 
  kClassType_AttributeClass, 
  kClassType_AssociationClass, 
  kClassType_RoleClass, 
} ClassType;
 
typedef enum ClassCatalogProperty {
  kClassCatalogProperty_PRSP = 0, 
  kClassCatalogProperty_Version, 
  kClassCatalogProperty_Date, 
  kClassCatalogProperty_Name,           
  kClassCatalogProperty_Scope,          
  kClassCatalogProperty_TopicCategory,  
  kClassCatalogProperty_VersionNumber_Original, 
  kClassCatalogProperty_VersionDate_Original, 
  kClassCatalogProperty_Producer_IndividualName, 
  kClassCatalogProperty_Producer_OrganisationName, 
  kClassCatalogProperty_Producer_PositionName, 
  kClassCatalogProperty_Producer_ContactInfo, 
  kClassCatalogProperty_Producer_Role, 
} ClassCatalogProperty;
 
typedef enum AttributeClassType {
  kAttributeClassType_Undefined = 0, 
  kAttributeClassType_Text, 
  kAttributeClassType_Enum, 
  kAttributeClassType_Real, 
  kAttributeClassType_Date, 
  kAttributeClassType_Int,  
  kAttributeClassType_Complex, 
  kAttributeClassType_List, 
  // TODO: Check with S-100
} AttributeClassType;
 
typedef enum ClassProperty {
  kClassProperty_Code = 0,  
  kClassProperty_Name, 
  kClassProperty_Definition, 
  kClassProperty_Remarks, 
  kClassProperty_Alias,     
  kClassProperty_ClassType, 
  kClassProperty_Abbreviation, 
  kClassProperty_NoValue, 
  kClassProperty_MeasurementType, 
  kClassProperty_MeasurementUnit, 
  kClassProperty_MeasurementResolution, 
} ClassProperty;
 
typedef enum FeatureClassType {
  kFeatureClassType_Undefined = 0, 
  kFeatureClassType_Geographic, 
  kFeatureClassType_Meta, 
  kFeatureClassType_Theme, 
  kFeatureClassType_Aggregation, 
  // TODO: Check with S-100
} FeatureClassType;
 
typedef enum FeatureClassFlags {
  kFeatureClassFlag_NoGeometry  = 0, 
  kFeatureClassFlag_Point       = 1, 
  kFeatureClassFlag_Curve       = 2, 
  kFeatureClassFlag_Surface     = 4, 
} FeatureClassFlags;
 
typedef enum ClassBindingProperty {
  kClassBindingProperty_Sequential = 0, 
  kClassBindingProperty_Multiplicity_Lower, 
  kClassBindingProperty_Multiplicity_Upper, 
} ClassBindingProperty;
 
typedef enum ClassValueProperty {
  kClassValueProperty_Name = 0, 
  kClassValueProperty_Definition, 
  kClassValueProperty_Symbol, 
  //Abbreviation
} ClassValueProperty;
 
typedef enum ClassListedValueProperty {
  kClassListedValueProperty_Code = 0, 
  kClassListedValueProperty_Label, 
  kClassListedValueProperty_Definition, 
  kClassListedValueProperty_Abbreviation, 
} ClassListedValueProperty;
 
class IClassCatalog : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE GetClassCount(
    ClassType class_type,
    SDKUInt64* count) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetClass(
    ClassType class_type,
    SDKUInt64 index,
    IClass** class_ref) const throw() = 0;
 
   virtual GDBResult SDK_CALLTYPE GetClasses(
     ClassType class_type,
     SDKUInt64 index, 
     SDKUInt64 count, 
     IClass** class_ref) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE FindClassByCode(
    ClassType class_type,
    ClassCode class_code,
    IClass** class_ref) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE FindClassByAlias(
    ClassType class_type,
    const SDKString& alias,
    IClass** class_ref) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetProperty(
    ClassCatalogProperty id,
    SDKAny& value) const throw() = 0;
 
  template< typename T >
  GDBResult GetPropertyT(ClassCatalogProperty id, T& out) const throw() {
    sdk::ScopedAny value;
    GDBResult res = GetProperty(id, value);
    if (SDK_FAILED(res))
      return res;
    return value.GetAs< T >(out) ? sdk::Ok : sdk::Err_InvalidArg;
  }
 
  SDK_IMPLEMENT_IID(IClassCatalog)
  SDK_END_INTERFACE(IClassCatalog)
};
SDK_DECLARE_IID(IClassCatalog)
 
class IClass : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE GetCode(
    ClassCode* code) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetBindings(
    IEnumClassBinding** bindings) throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetProperty(
    ClassProperty id,
    SDKAny& value) const throw() = 0;
 
  template< typename T >
  GDBResult GetPropertyT(ClassProperty id, T& out) const throw() {
    sdk::ScopedAny value;
    GDBResult res = GetProperty(id, value);
    if (SDK_FAILED(res))
      return res;
    return value.GetAs< T >(out) ? sdk::Ok : sdk::Err_InvalidArg;
  }
 
  SDK_IMPLEMENT_IID(IClass)
  SDK_END_INTERFACE(IClass)
};
SDK_DECLARE_IID(IClass)
 
class IAttributeClass : public IClass {
public:
  virtual GDBResult SDK_CALLTYPE GetAttributeClassType(
    AttributeClassType& class_type) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetListedValues(
    IEnumClassListedValue** listed_values) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE FindListedValue(SDKUInt64 code,
    IClassListedValue** listed_value) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetValueDefinition(
    IClassValue** value) const throw() = 0;
  
  SDK_IMPLEMENT_IID(IAttributeClass)
  SDK_END_INTERFACE(IAttributeClass)
};
SDK_DECLARE_IID(IAttributeClass)
 
class IFeatureClass : public IClass {
public:
  virtual GDBResult SDK_CALLTYPE GetFeatureClassType(
    FeatureClassType* class_type) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetFeatureClassFlag(
    SDKUInt64* class_flag) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IFeatureClass)
  SDK_END_INTERFACE(IFeatureClass)
};
SDK_DECLARE_IID(IFeatureClass)
 
class IEnumClassListedValue : public IEnumSDKComponent {
public:
  SDK_IMPLEMENT_IID(IEnumClassListedValue)
  SDK_END_INTERFACE(IEnumClassListedValue)
};
SDK_DECLARE_IID(IEnumClassListedValue)
 
class IEnumClassBinding : public IEnumSDKComponent {
public:
  SDK_IMPLEMENT_IID(IEnumClassBinding)
  SDK_END_INTERFACE(IEnumClassBinding)
};
SDK_DECLARE_IID(IEnumClassBinding)
 
class IClassBinding : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE GetClass(
    IClass** class_ref) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetProperty(
    ClassBindingProperty id, 
    SDKAny& value) const throw() = 0;
 
  virtual GDBResult SDK_CALLTYPE GetPermittedValues(
    IEnumSDKAny** value) const throw() = 0;
 
  template< typename T >
  GDBResult GetPropertyT(ClassBindingProperty id, T& out) const throw() {
    sdk::ScopedAny value;
    GDBResult res = GetProperty(id, value);
    if (SDK_FAILED(res))
      return res;
    return value.GetAs< T >(out) ? sdk::Ok : sdk::Err_InvalidArg;
  }
 
  SDK_IMPLEMENT_IID(IClassBinding)
  SDK_END_INTERFACE(IClassBinding)
};
SDK_DECLARE_IID(IClassBinding)
 
class IClassValue : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE GetProperty(
    ClassValueProperty id,
    SDKAny& value) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IClassValue)
  SDK_END_INTERFACE(IClassValue)
};
SDK_DECLARE_IID(IClassValue)
 
class IClassListedValue : public IGDBObject {
public:
  virtual GDBResult SDK_CALLTYPE GetProperty(
    ClassListedValueProperty id,
    SDKAny& value) const throw() = 0;
 
  SDK_IMPLEMENT_IID(IClassListedValue)
  SDK_END_INTERFACE(IClassListedValue)
};
SDK_DECLARE_IID(IClassListedValue)
 
SDK_GDB_END_NAMESPACE
 
#endif // SDK_GDB_FEATURE_CATALOG_INTERFACE_H_