gdb_const.h

Go to the documentation of this file.

 
#ifndef SDK_GDB_CONST_H_
#define SDK_GDB_CONST_H_
 
#include <base/inc/platform.h>
#include <base/inc/base_types.h>
#include <base/inc/sdk_component_interface.h>
 
#ifndef SDK_GDB_NAMESPACE
#define SDK_GDB_NAMESPACE SDK_NAMESPACE::gdb
#endif // SDK_GDB_NAMESPACE
 
#ifndef SDK_GDB_BEGIN_NAMESPACE
#define SDK_GDB_BEGIN_NAMESPACE namespace SDK_NAMESPACE {   \
                                namespace gdb {
#endif // SDK_GDB_BEGIN_NAMESPACE
 
#ifndef SDK_GDB_END_NAMESPACE
#define SDK_GDB_END_NAMESPACE } }
#endif // SDK_GDB_END_NAMESPACE
 
SDK_GDB_BEGIN_NAMESPACE
 
 
typedef SDKResult GDBResult; // Result is used for return values.
typedef ISDKComponent IGDBObject;
 
static const double kInfiniteDegree = 361.0;
 
typedef SDKUInt32 DatasetID;
#define DatasetID_SDKAnyType kSDKAnyType_Uint32
#define DatasetID_SDKAnyValue(v) ANY_UI32(v)
typedef SDKUInt8 WorkspaceID;
#define ObjectID_SDKAnyType kSDKAnyType_Uint64
#define ObjectID_SDKAnyValue(v) ANY_UI64(v)
 
#define DatasetID_SlaveDatasetMask 0x00C00000
#define DatasetID_MakeID(workspace, dataset) \
  ((static_cast<sdk::gdb::DatasetID>(workspace) << 24) | (dataset & 0x003FFFFF))
#define DatasetID_MakeID_ForSlaveDataset(workspace, dataset, slave_dataset) \
  (DatasetID_MakeID(workspace, dataset) | \
  ((slave_dataset << 22) & DatasetID_SlaveDatasetMask))
#define DatasetID_DatasetID(did) \
  static_cast<sdk::gdb::DatasetID>(did & 0x003FFFFF)
#define DatasetID_MarkSlaveDataset(did, slave_dataset) \
  (did | ((slave_dataset << 22) & DatasetID_SlaveDatasetMask))
#define DatasetID_Native(did) (did & ~DatasetID_SlaveDatasetMask)
#define DatasetID_WorkspaceID(did) static_cast<sdk::gdb::WorkspaceID>(did >> 24)
#define DatasetID_WorkspaceID_MaxValue 255
#define DatasetID_WorkspaceID_ExternalUser 220
#define DatasetID_WorkspaceID_InternalUser 200
 
typedef enum WorkspaceID_InternalUser {
  kWorkspaceID_InternalUser_OwnShip = DatasetID_WorkspaceID_InternalUser,
  kWorkspaceID_InternalUser_RadarTargets,
  kWorkspaceID_InternalUser_AISTargets,
  kWorkspaceID_InternalUser_Routes,
  kWorkspaceID_InternalUser_TotalTide,
  kWorkspaceID_InternalUser_ADP,
  kWorkspaceID_InternalUser_ARCS,
} WorkspaceID_InternalUser;
 
static const char kWorkspace_InternalUser_Name_OwnShip[] = "Workspace_OwnShip";
static const char kWorkspace_InternalUser_Name_RadarTargets[] = 
  "Workspace_RadarTargets";
static const char kWorkspace_InternalUser_Name_AISTargets[] = 
  "Workspace_AISTargets";
static const char kWorkspace_InternalUser_Name_Routes[] = 
  "Workspace_Routes";
static const char kWorkspace_InternalUser_Name_TotalTide[] = 
  "Workspace_TotalTide";
static const char kWorkspace_InternalUser_Name_ADP[] = 
  "Workspace_ADP";
static const char kWorkspace_InternalUser_Name_LOP[] = 
  "Workspace_LOP";
static const char kWorkspace_InternalUser_Name_ARCS[] =
  "Workspace_ARCS";
 
#if defined(__cplusplus)
inline bool IsEqualDatasetID(const sdk::gdb::DatasetID& did1, 
  const DatasetID& did2) {
  return (did1 == did2);
}
inline void InitDatasetID(sdk::gdb::DatasetID& _did) { _did = -1; }
inline bool IsNullDatasetID(const DatasetID& did) {
  return (did == static_cast<SDKUInt32>(-1));
}
inline bool IsSlaveDataset(const DatasetID& did) {
  return (did & DatasetID_SlaveDatasetMask) ? true : false;
}
#else
#define IsEqualDatasetID(did1, did2)  (did1 == did2)
#define InitDatasetID(did) did = -1;
#define IsNullDatasetID(did)  (did == -1)
#define IsSlaveDataset(did) (did & DatasetID_SlaveDatasetFlag)
#endif
 
typedef SDKUInt32 OID;
typedef SDKUInt64 RAW_OID;
 
union ObjectID {
  RAW_OID raw_oid;
  struct {
    DatasetID did;  
    OID oid;  
  };
};
#define ObjectID_OID(section, record) \
  ((static_cast<SDKUInt32>(section) << 24) | (record & 0x00FFFFFF))
#define ObjectID_Record(id) \
  static_cast<sdk::gdb::senc::UInt32>(id.oid & 0x00FFFFFF)
#define ObjectID_Section(id) \
  static_cast<sdk::gdb::senc::SECI_ENUM>(id.oid >> 24)
#define ObjectID_DatasetID(id) DatasetID_DatasetID(id.did)
#define ObjectID_WorkspaceID(id) DatasetID_WorkspaceID(id.did)
#define ObjectID_MakeObjectID(did, oid) \
  ((did & 0x00000000FFFFFFFFULL) | \
  ((static_cast<SDKUInt64>(oid) << 32) & 0xFFFFFFFF00000000ULL))
 
#if defined(__cplusplus)
 
inline bool IsEqualObjectID(const ObjectID& oid1, const ObjectID& oid2) {
  return (IsEqualDatasetID(oid1.did, oid2.did) && (oid1.oid == oid2.oid));
}
 
inline int operator==(const ObjectID& oid1, const ObjectID& oid2) {
  return IsEqualObjectID(oid1, oid2);
}
 
inline void InitObjectID(ObjectID& oid) {InitDatasetID(oid.did); oid.oid = 0;}
inline bool IsNullObjectID(const ObjectID& oid) {
  return (IsNullDatasetID(oid.did) && (oid.oid == 0));
}
#else
  #define IsEqualObjectID(oid1, oid2)  \
    (IsEqualDatasetID(oid1.did, oid2.did) && (oid1.oid == oid2.oid))
  #define InitObjectID(oid) \
    InitDatasetID(oid.did) oid.oid = 0; 
  #define IsNullObjectID(oid)  \
    (IsNullDatasetID(oid.did) && (oid.oid == 0))
#endif
 
// const ObjectID kNULL_OID = { 0xFFFFFFFF00000000UL };
 
typedef SDKUInt32 RCID;
static const SDKUInt32 kRCIDAnyType = kSDKAnyType_Uint32;
static const RCID kUndefinedRCID = -1;
static const RCID kDeprecatedRCID = 0;
 
union FOID {
  SDKUInt64 foid;
  struct {
    SDKUInt16 agen; 
    SDKUInt16 fids; 
    SDKUInt32 fidn; 
  };
};
union MU_FOID {
  SDKUInt64 foid;
  struct {
    SDKUInt16 agen; 
    SDKUInt16 rcid; 
    SDKUInt32 relation; 
  };
};
const FOID kNULL_FOID = {0};
const MU_FOID kNULL_MU_FOID = {0};
 
inline bool IsNullFOID(const FOID& foid) {
  return (kNULL_FOID.foid == foid.foid);
}
 
inline bool IsNullMU_FOID(const MU_FOID& foid) {
  return (kNULL_FOID.foid == foid.foid);
}
 
inline void InitFOID(FOID& foid) {
  foid.foid = kNULL_FOID.foid;
}
 
inline void InitMU_FOID(MU_FOID& foid) {
  foid.foid = kNULL_FOID.foid;
}
 
// Converts chart (senc) object RCID to appropriate MU FOID for 
// GetFeaturesByFOID method
inline FOID GetMUFoidFromChartObjectRCID(const RCID& chart_obj_rcid) {
  FOID foid;
  foid.agen = 0;
  foid.fids = 0;
  foid.fidn = chart_obj_rcid;
 
  return foid;
}
 
#if defined(__cplusplus)
inline bool IsEqualFOID(const FOID& foid1, const FOID& foid2) {
  return (foid1.agen == foid2.agen && foid1.fidn == foid2.fidn &&
    foid1.fids == foid2.fids);
}
#else
#define IsEqualFOID(foid1, foid2)  \
  (foid1.agen == foid2.agen && foid1.fidn == foid2.fidn \
  && foid1.fids == foid2.fids)
#endif
 
typedef SDKUInt32 ClassCode;
#define ClassCode_SDKAnyType kSDKAnyType_Uint32
#define ClassCode_SDKAnyValue(v) ANY_UI32(v)
 
static const SDKUInt32 kInvalidClassCode = 0;
static const SDKUInt32 kAnyClassCode = kInvalidClassCode;
 
// \brief Definition of the feature and attribute types.
 
typedef ClassCode FeatureClassCode; 
typedef ClassCode AttributeClassCode; 
typedef SDKUInt32 PRSP; 
static const SDKUInt32 kSDKAnyType_PRSP = kSDKAnyType_Uint32;
#define PRSP_SDKAnyType kSDKAnyType_Uint32
#define PRSP_SDKAnyValue(v) ANY_UI32(v)
 
typedef enum PRSPEnum {
  kPRSP_Unknown         = 0,   
  kPRSP_S101            = 1,   
  kPRSP_S106            = 6,   
  kPRSP_S107            = 7,   
  kPRSP_InlandENC       = 10,  
  kPRSP_AML12_MFF       = 51,  
  kPRSP_AML12_Routes    = 52,  
  kPRSP_AML12_LBO       = 53,  
  kPRSP_AML12_CLB       = 54,  
  kPRSP_AML12_ESB       = 55,  
  kPRSP_AML12_SBO       = 56,  
  kPRSP_AML3            = 57,  
  kPRSP_AIO             = 80,  
  kPRSP_OVERVIEW_CHART  = 255, 
  kPRSP_VESSELS         = 254, 
  kPRSP_OWNSHIP         = 253, 
  kPRSP_ARPA            = 252, 
  kPRSP_AIS             = 251, 
  kPRSP_RADAR           = 250, 
  kPRSP_TotalTide       = 249, 
  kPRSP_MarinerObjects  = 248, 
  kPRSP_NavtexObjects   = 247, 
  kPRSP_ListOfLights    = 246, 
  kPRSP_SignalsVol2     = 245, 
  kPRSP_SignalsVol6     = 244, 
  kPRSP_SignalsVol1345  = 243, 
  kPRSP_Navareas        = 242, 
  kPRSP_AeNPCatalogue   = 241, 
  kPRSP_ARCS            = 240, 
  kPRSP_LoadLines       = 225, 
  kPRSP_Service         = 224, 
  kPRSP_Repareas        = 222, 
  kPRSP_TimeZones       = 221, 
  kPRSP_MARPOL          = 220, 
  kPRSP_IENC_Bathymetry = 200, 
  kPRSP_Weather_Old     = 200, 
  kPRSP_Weather_New     = 2000, 
  kPRSP_Ports           = 2010, 
  kPRSP_User            = SDK_MAX_UINT16 + 1
} PRSPEnum;
 
// \brief Relationship constants and structures.
 
typedef enum RelationshipRole {
  kRelationshipRole_Any = 0,     
  kRelationshipRole_Master,      
  kRelationshipRole_Slave,       
} RelationshipRole;
 
typedef enum RelationshipClass {
  kRelationshipClass_Any = 0, 
  kRelationshipClass_MasterSlave, 
  kRelationshipClass_PeerToPeer,  
  kRelationshipClass_SpatialAssociation, 
  kRelationshipClass_AssociationMaster, 
  kRelationshipClass_RCID, 
  kRelationshipClass_ManualUpdates, 
  kRelationshipClass_FOID, 
  kRelationshipClass_ManualUpdatesHistory, 
  kRelationshipClass_ManualUpdatesHistoryBackward, 
} RelationshipClass;
 // End of constants
 
typedef enum DebugFlags {
  kDebugFlag_WorkspaceDatasetList = 1,
  kDebugFlag_WorkspaceDatasetListCount = 2,
} DebugFlags;
 
static const SDKUInt32 kScaleMin_InvalidValue = 0;
static const SDKUInt32 kScaleMax_InvalidValue = -1;
 
SDK_GDB_END_NAMESPACE
 
#endif // SDK_GDB_CONST_H_