c_api.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2021 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/

#pragma  once

#include "legionDataStoreImpl/export.h"

#ifdef __cplusplus
extern "C" {
#endif

   /****  C API Handles  ****/  
   typedef unsigned long long  DatabaseHandle;
   typedef unsigned long long  EntityManagerHandle;
   typedef unsigned long long  ViewManagerHandle;
   typedef unsigned long long  ConfigHandle;
   typedef unsigned long long  ConfigGroupHandle;
   typedef unsigned long long  EventManagerHandle;
   typedef unsigned long long  ControlManagerHandle;
   typedef unsigned long long  OwnershipManagerHandle;
   typedef unsigned long long  InteractionHandle;
   typedef unsigned long long  EventHandle;
   typedef unsigned long long  ControlHandle;
   typedef unsigned long long  AttributeSetHandle;
   typedef unsigned long long  ViewHandle;
   typedef unsigned long long  InstanceHandle;
   typedef unsigned long long  ConnectionHandle;
   /****  C API Object IDs ****/
   typedef unsigned long long  GlobalId;
   typedef unsigned int        ClientId;
   typedef unsigned int        AttributeId;
   typedef unsigned int        AttributeIndex;
   typedef unsigned int        ParameterId;
   typedef unsigned int        EventId;
   typedef unsigned int        ControlId;
   typedef unsigned int        AttributeSetId;
   typedef unsigned long long  TransactionId;
   typedef unsigned char       UInt8;
   typedef signed char         Int8;
   typedef unsigned short      UInt16;
   typedef short               Int16;
   typedef unsigned int        UInt32;
   typedef int                 Int32;
   typedef unsigned long long  UInt64;
   typedef long long           Int64;
   typedef UInt8               Bool;


   typedef enum
   {
      Return_success = 0,
      Return_invalidHandle,
      Return_invalidInput,
      Return_invalidOperation,
      Return_fileOpenFailed,
      Return_managerObjectNotFound,
      Return_noSuchAttributeSet,
      Return_noSuchAttributeTable,
      Return_noSuchAttributeInstance,
      Return_noSuchEventTable,
      Return_noSuchEventInstance,
      Return_noAttributeData,
      Return_userDataBufferTooShort,
      Return_operationFailed,
      Return_hasMoreRecords,
      Return_hasLessRecords,
      Return_variableSizeData,
      Return_unknownDataType,
      Return_connectionError,

      Return_noSuchValue = 0xFFFFFFFF
   }  LEG_ReturnCode;

   typedef enum
   {
      DataType_Bool,
      DataType_UInt8,
      DataType_Int8,
      DataType_UInt16,
      DataType_Int16,
      DataType_UInt32,
      DataType_Int32,
      DataType_UInt64,
      DataType_Int64,
      DataType_Float,
      DataType_Double,
      DataType_Vector2f,
      DataType_Vector2d,
      DataType_Vector3f,
      DataType_Vector3d,
      DataType_Vector4f,
      DataType_Vector4d,
      DataType_ObjectType
   } LEG_DataType;

   typedef enum
   {
      Bool_False,  
      Bool_True    
   } LEG_Bool;

   
   typedef struct
   {
      union {
         struct {
            float x;
            float y;
         };
         float data[2];
      };
   } LEG_vector2f;

   typedef struct
   {
      union {
         struct {
            double x;
            double y;
         };
         double data[2];
      };
   } LEG_vector2d;

   typedef struct
   {
      union {
         struct {
            float x;
            float y;
            float z;
         };
         float data[3];
      };
   } LEG_vector3f;

   typedef struct
   {
      union {
         struct {
            double x;
            double y;
            double z;
         };
         double data[3];
      };
   } LEG_vector3d;

   typedef struct
   {
      union {
         struct {
            float x;
            float y;
            float z;
            float w;
         };
         float data[4];
      };
   } LEG_vector4f;

   typedef struct
   {
      union {
         struct {
            double x;
            double y;
            double z;
            double w;
         };
         double data[4];
      };
   } LEG_vector4d;

   typedef struct
   {
      union {
         struct
         {
            Int8    kind;
            Int8    domain;
            Int16   country;
            Int8    category;
            Int8    subcategory;
            Int8    specific;
            Int8    extra;
         };
         Int8 data[8];
      };

   } LEG_object_type;

   typedef enum
   {
      View_Local = 0,
      View_Remote,
      View_All,
   } LEG_Scope;

   typedef struct
   {
      InstanceHandle inst;
      UInt32* attributes;
      UInt32 attrCount;
   }LEG_InstanceUpdateData;


#ifdef __cplusplus
}
#endif