sdai.h

Go to the documentation of this file.

// Copyright (C) 2002-2019, Open Design Alliance (the "Alliance"). 
// All rights reserved. 
// 
// This software and its documentation and related materials are owned by 
// the Alliance. The software may only be incorporated into application 
// programs owned by members of the Alliance, subject to a signed 
// Membership Agreement and Supplemental Software License Agreement with the
// Alliance. The structure and organization of this software are the valuable  
// trade secrets of the Alliance and its suppliers. The software is also 
// protected by copyright law and international treaty provisions. Application  
// programs incorporating this software must include the following statement 
// with their copyright notices:
//   
//   This application incorporates Open Design Alliance software pursuant to a license 
//   agreement with Open Design Alliance.
//   Open Design Alliance Copyright (C) 2002-2019 by Open Design Alliance. 
//   All rights reserved.
//
// By use of this software, its documentation or related materials, you 
// acknowledge and accept the above terms.
 
#ifndef _SDAI_
#define _SDAI_
 
#include "daiError/daiErrorId.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct Sdai_instS {
  int pInst;
};
 
struct Sdai_aggrS {
  int pAggr;
};
 
typedef struct Sdai_instS * SdaiId;
 
typedef struct Sdai_Id_aggr * SdaiId_aggr;
 
typedef struct Sdai_ItrId * SdaiItrId;
 
typedef struct Sdai_ADBId * SdaiADBId;
 
typedef unsigned SdaiIndexId;
 
/*** Constant declarations ******************************************/
 
/* LOGICAL and BOOLEAN value elements: */
 
#define sdaiFALSE 0
#define sdaiTRUE 1
#define sdaiUNKNOWN 2
 
/* BINARY value elements: */
 
#define sdaiBIT0 '0'
#define sdaiBIT1 '1'
 
/* EXPRESS built-in constants: */
 
#define sdaiE 2.7182818284590451353602874713
#define sdaiPI 3.1415926353897932384626433832
 
 
/*** Type declarations **********************************************/
 
typedef unsigned char SdaiBit;
 
/* C late binding simple data types: */
 
typedef long SdaiInteger;
 
typedef double SdaiReal;
 
typedef SdaiReal SdaiNumber;
 
typedef int SdaiBoolean;
 
typedef int SdaiLogical;
 
typedef char *SdaiString;
 
typedef SdaiBit *SdaiBinary;
 
/* enumeration data type: */
typedef char *SdaiEnum;
 
/* aggregate data types: */
 
typedef SdaiId_aggr       SdaiAggr;
 
typedef SdaiAggr          SdaiOrderedAggr;
 
typedef SdaiAggr          SdaiUnorderedAggr;
 
typedef SdaiOrderedAggr   SdaiArray;
 
typedef SdaiOrderedAggr   SdaiList;
 
typedef SdaiUnorderedAggr SdaiSet;
 
typedef SdaiUnorderedAggr SdaiBag;
 
typedef enum {
  sdaiADB, sdaiAGGR, sdaiBINARY, sdaiBOOLEAN,
  sdaiENUM, sdaiINSTANCE, sdaiINTEGER, sdaiLOGICAL,
  sdaiNOTYPE, sdaiNUMBER, sdaiREAL, sdaiSTRING
}
SdaiPrimitiveType;
 
/* entity instance identifier type: */
 
typedef SdaiId      SdaiInstance;
 
/* SDAI instance identifier types: */
 
typedef SdaiInstance          SdaiAppInstance;
 
typedef SdaiInstance          SdaiModel;
 
typedef SdaiInstance          SdaiRep;
 
typedef SdaiInstance          SdaiSession;
 
typedef SdaiInstance          SdaiAttr;
 
typedef SdaiAttr              SdaiExplicitAttr;
 
typedef SdaiInstance          SdaiNamedType;
 
typedef SdaiNamedType         SdaiEntity;
 
//typedef SdaiNamedType         SdaiDefinedType;
 
typedef SdaiInstance          SdaiWhereRule;
 
typedef SdaiInstance          SdaiUniRule;
 
typedef SdaiInstance          SdaiGlobalRule;
 
typedef SdaiInstance          SdaiSchema;
 
typedef SdaiInstance          SdaiScope;
 
typedef SdaiInstance          SdaiSchemaInstance;
 
typedef SdaiInstance          SdaiTrx;
 
 
typedef SdaiItrId             SdaiIterator;
 
/* Non-persistent list data type: */
 
//typedef SdaiList              SdaiNPL;
 
typedef enum {
  sdaiQUERY_AGGR, sdaiQUERY_MODEL, sdaiQUERY_REP,
  sdaiQUERY_SCHEMAINSTANCE
} SdaiQuerySourceType;
 
typedef enum { Access_type_unset, sdaiRO, sdaiRW } SdaiAccessMode;
 
typedef SdaiADBId SdaiADB;
 
typedef SdaiIndexId SdaiAggrIndex;
 
typedef SdaiErrorId SdaiErrorCode;
 
typedef void(*SdaiErrorHandler)(SdaiErrorCode);
 
/* the ANSI-C style function prototypes of the SDAI operations */
 
#include "daiBuildOptions.h"
 
/* 6.1 Environment operations */
 
DAI_EXPORT SdaiSession sdaiOpenSession(void);
 
DAI_EXPORT int sdaiLogicalCompare(SdaiLogical value1, SdaiLogical value2);
 
DAI_EXPORT SdaiErrorCode sdaiErrorQuery(void);
 
DAI_EXPORT void sdaiSetErrorHandler(SdaiErrorHandler function);
 
DAI_EXPORT SdaiErrorHandler sdaiRestoreErrorHandler(void);
 
DAI_EXPORT SdaiBoolean sdaiIsEqual(SdaiInstance instance1, SdaiInstance instance2);
 
 
/* 6.2 Session operations */
 
DAI_EXPORT void sdaiRecordEvent(SdaiSession session, SdaiString functionName, SdaiErrorCode error, SdaiString description);
 
DAI_EXPORT SdaiBoolean sdaiSetEventRecording(SdaiSession session, SdaiBoolean setRec);
 
DAI_EXPORT void sdaiCloseSession(SdaiSession session);
 
DAI_EXPORT SdaiRep sdaiOpenRepository(SdaiSession session, SdaiRep repository);
 
DAI_EXPORT SdaiRep sdaiOpenRepositoryBN(SdaiSession session, SdaiString repositoryName);
 
//DAI_EXPORT SdaiTrx sdaiStartTrx(SdaiSession session, SdaiAccessMode mode);
//DAI_EXPORT void sdaiBreakTrx(SdaiTrx transaction, SdaiCommitMode mode);
//DAI_EXPORT void sdaiEndTrx (SdaiTrx transaction, SdaiCommitMode mode);
//DAI_EXPORT SdaiNPL sdaiCreateNPL(void);
//DAI_EXPORT void sdaiDeleteNPL(SdaiNPL list);
//DAI_EXPORT SdaiInteger sdaiQuery(SdaiQuerySourceType sourceType, SdaiString criteria, SdaiInstance instance, SdaiNPL result, ...);
 
DAI_EXPORT SdaiLogical sdaiIsRecordingOn (SdaiSession session);
 
DAI_EXPORT SdaiADB sdaiCreateADB(SdaiPrimitiveType valueType, ...);
 
DAI_EXPORT SdaiADB sdaiCreateEmptyADB(void);
 
DAI_EXPORT void* sdaiGetADBValue(SdaiADB block, SdaiPrimitiveType valueType, void *value);
 
DAI_EXPORT void sdaiPutADBValue(SdaiADB block, SdaiPrimitiveType valueType, ...);
 
DAI_EXPORT SdaiPrimitiveType sdaiGetADBType(SdaiADB block);
 
DAI_EXPORT void sdaiUnsetADB(SdaiADB block);
 
DAI_EXPORT void sdaiDeleteADB(SdaiADB block);
 
/* 6.3 Repository operations */
 
DAI_EXPORT SdaiModel sdaiCreateModel(SdaiRep repository, SdaiString modelName, SdaiSchema schema);
 
DAI_EXPORT SdaiModel sdaiCreateModelBN(SdaiRep repository, SdaiString modelName, SdaiString schemaName);
 
DAI_EXPORT SdaiSchemaInstance sdaiCreateSchemaInstance(SdaiString schemaInstanceName, SdaiSchema schema, SdaiRep repository);
 
DAI_EXPORT SdaiSchemaInstance sdaiCreateSchemaInstanceBN(SdaiString schemaInstanceName, SdaiString schemaName, SdaiRep repository);
 
DAI_EXPORT void sdaiCloseRepository(SdaiRep repository);
 
 
/* 6.4 Schema instance operations */
 
DAI_EXPORT void sdaiDeleteSchemaInstance(SdaiSchemaInstance schemaInstance);
 
DAI_EXPORT void sdaiDeleteSchemaInstanceBN(SdaiString schemaInstanceName, SdaiRep repository);
 
DAI_EXPORT void sdaiRenameSchemaInstance(SdaiSchemaInstance schemaInst, SdaiString schemaInstName);
 
DAI_EXPORT void sdaiRenameSchemaInstanceBN(SdaiString schemaInstOldName, SdaiRep repository, SdaiString schemaInstName);
 
DAI_EXPORT void sdaiAddModel(SdaiSchemaInstance schemaInstance, SdaiModel model);
 
DAI_EXPORT void sdaiAddModelBN(SdaiSchemaInstance schemaInstance, SdaiRep repository, SdaiString modelName);
 
DAI_EXPORT void sdaiRemoveModel(SdaiSchemaInstance schemaInstance, SdaiModel model);
 
DAI_EXPORT void sdaiRemoveModelBN(SdaiSchemaInstance schemaInstance, SdaiRep repository, SdaiString modelName);
 
//DAI_EXPORT SdaiLogical sdaiValidateGlobalRule(SdaiSchemaInstance schemaInstance, SdaiGlobalRule rule, SdaiNPL list);
//DAI_EXPORT SdaiLogical sdaiValidateGlobalRuleBN(SdaiSchemaInstance schemaInstance, SdaiString ruleName, SdaiNPL list);
//DAI_EXPORT SdaiLogical sdaiValidateUniqueness(SdaiSchemaInstance schemaInstance, SdaiUniRule uniRule, SdaiNPL list);
//DAI_EXPORT SdaiLogical sdaiValidateUniquenessBN(SdaiSchemaInstance schemaInstance, SdaiString entityName, SdaiString uniRuleName, SdaiNPL list);
//DAI_EXPORT SdaiLogical sdaiValidateReferenceDomain(SdaiSchemaInstance schemaInstance, SdaiAppInstance appInstance, SdaiNPL list);
//DAI_EXPORT SdaiLogical sdaiValidateSchemaInstance(SdaiSchemaInstance schemaInstance);
//DAI_EXPORT SdaiBoolean sdaiIsValidationCurrent(SdaiSchemaInstance schemaInstance);
//DAI_EXPORT SdaiBoolean sdaiIsValidationCurrent(SdaiSchemaInstance schemaInstance);
 
DAI_EXPORT SdaiSchema sdaiGetSchema(SdaiString schemaName);
 
DAI_EXPORT SdaiSchemaInstance sdaiGetSchemaInstance(SdaiString schemaInstanceName, SdaiRep repository);
 
 
/* 6.5 SDAI-model operations */
 
DAI_EXPORT void sdaiDeleteModel(SdaiModel model);
 
DAI_EXPORT void sdaiDeleteModelBN(SdaiRep repository, SdaiString modelName);
 
DAI_EXPORT void sdaiRenameModel(SdaiModel model, SdaiString modelName);
 
DAI_EXPORT void sdaiRenameModelBN(SdaiRep repository, SdaiString modelOldName, SdaiString modelName);
 
DAI_EXPORT SdaiModel sdaiAccessModel(SdaiModel model, SdaiAccessMode mode);
 
DAI_EXPORT SdaiModel sdaiAccessModelBN(SdaiRep repository, SdaiString modelName, SdaiAccessMode mode);
 
DAI_EXPORT void sdaiPromoteModel(SdaiModel model);
 
DAI_EXPORT void sdaiEndModelAccess(SdaiModel model);
 
DAI_EXPORT SdaiEntity sdaiGetEntity(SdaiModel model, SdaiString name);
 
DAI_EXPORT SdaiAppInstance sdaiCreateInstance(SdaiModel model, SdaiEntity entity);
 
DAI_EXPORT SdaiAppInstance sdaiCreateInstanceBN(SdaiModel model, SdaiString entityName);
 
DAI_EXPORT void sdaiUndoChanges(SdaiModel model);
 
DAI_EXPORT void sdaiSaveChanges(SdaiModel model);
 
//DAI_EXPORT SdaiAppInstance sdaiCreateComplexInstance(SdaiModel model, SdaiNPL entityList);
 
DAI_EXPORT SdaiAppInstance sdaiCreateComplexInstanceBN(SdaiModel model, SdaiInteger nameNumber, SdaiString *nameVector);
 
DAI_EXPORT SdaiSet sdaiGetEntityExtent(SdaiModel model, SdaiEntity entity);
 
 
DAI_EXPORT SdaiSet sdaiGetEntityExtentBN(SdaiModel model, SdaiString name);
 
 
/* 6.6 Scope operations */
 
 
/* 6.7 Type operations */
 
//DAI_EXPORT SdaiEntity sdaiGetComplexEntity(SdaiNPL entityList);
//DAI_EXPORT SdaiEntity sdaiGetComplexEntityBN(SdaiString schemaName, SdaiInteger nameNumber, SdaiString *nameVector);
 
DAI_EXPORT SdaiBoolean sdaiIsSubtypeOf(SdaiEntity subtype, SdaiEntity supertype);
 
DAI_EXPORT SdaiBoolean sdaiIsSubtypeOfBN(SdaiString schemaName, SdaiString subName, SdaiString superName);
 
DAI_EXPORT SdaiBoolean sdaiIsSDAISubtypeOf(SdaiEntity subtype, SdaiEntity supertype);
 
DAI_EXPORT SdaiBoolean sdaiIsSDAISubtypeOfBN(SdaiString schemaName, SdaiString subName, SdaiString superName);
 
DAI_EXPORT SdaiAttr sdaiGetAttrDefinition(SdaiEntity entity, SdaiString attrName);
 
DAI_EXPORT SdaiAttr sdaiGetAttrDefinitionBN(SdaiString schemaName, SdaiString entityName, SdaiString attrName);
 
/* 6.8 Entity instance operations */
 
DAI_EXPORT void* sdaiGetAttr(SdaiInstance instance, SdaiAttr attribute, SdaiPrimitiveType valueType, void *value);
 
DAI_EXPORT void* sdaiGetAttrBN(SdaiInstance instance, SdaiString attributeName, SdaiPrimitiveType valueType, void *value);
 
DAI_EXPORT SdaiBoolean sdaiTestAttr(SdaiInstance instance, SdaiAttr attribute);
 
DAI_EXPORT SdaiBoolean sdaiTestAttrBN(SdaiInstance instance, SdaiString attributeName);
 
DAI_EXPORT SdaiModel sdaiGetInstanceModel(SdaiInstance instance);
 
DAI_EXPORT SdaiEntity sdaiGetInstanceType(SdaiInstance instance);
 
DAI_EXPORT SdaiBoolean sdaiIsInstanceOf(SdaiInstance instance, SdaiEntity entity);
 
DAI_EXPORT SdaiBoolean sdaiIsInstanceOfBN(SdaiInstance instance, SdaiString entityName);
 
DAI_EXPORT SdaiBoolean sdaiIsKindOf(SdaiInstance instance, SdaiEntity entity);
 
DAI_EXPORT SdaiBoolean sdaiIsKindOfBN(SdaiInstance instance, SdaiString entityName);
 
DAI_EXPORT SdaiBoolean sdaiIsSDAIKindOf(SdaiInstance instance, SdaiEntity entity);
 
DAI_EXPORT SdaiBoolean sdaiIsSDAIKindOfBN(SdaiInstance instance, SdaiString entityName);
 
 
 
/* 6.8.13 Entity instance operations for convenience */
 
DAI_EXPORT void sdaiGetAttrs(SdaiInstance instance, SdaiInteger numberAttr, SdaiAttr attribute, SdaiPrimitiveType valueType, void *value, ...);
 
DAI_EXPORT void sdaiGetAttrsBN(SdaiInstance instance, SdaiInteger numberAttr, SdaiString attributeName, SdaiPrimitiveType valueType, void *value, ...);
 
DAI_EXPORT SdaiADB *sdaiGetAllAttrs(SdaiInstance instance, SdaiInteger *numberAttr);
 
/* 6.9 Application instance operations */
DAI_EXPORT SdaiAppInstance sdaiNearCopyInstance(SdaiAppInstance instance);
 
DAI_EXPORT SdaiAppInstance sdaiFarCopyInstance(SdaiAppInstance instance, SdaiModel model);
 
DAI_EXPORT void sdaiDeleteInstance(SdaiAppInstance instance);
 
DAI_EXPORT void sdaiPutAttr(SdaiAppInstance instance, SdaiExplicitAttr attribute, SdaiPrimitiveType valueType, ...);
 
DAI_EXPORT void sdaiPutAttrBN(SdaiAppInstance instance, SdaiString attributeName, SdaiPrimitiveType valueType, ...);
 
DAI_EXPORT void sdaiUnsetAttr(SdaiAppInstance instance, SdaiExplicitAttr attribute);
 
DAI_EXPORT void sdaiUnsetAttrBN(SdaiAppInstance instance, SdaiString attributeName);
 
DAI_EXPORT SdaiAggr sdaiCreateAggr(SdaiAppInstance instance, SdaiExplicitAttr attribute);
 
DAI_EXPORT SdaiAggr sdaiCreateAggrBN(SdaiAppInstance instance, SdaiString attributeName);
 
DAI_EXPORT SdaiAggr sdaiCreateAggrADB(SdaiAppInstance instance, SdaiExplicitAttr attribute, SdaiADB selaggrInstance);
 
DAI_EXPORT SdaiAggr sdaiCreateAggrADBBN(SdaiAppInstance instance, SdaiString attributeName, SdaiADB selaggrInstance);
 
 
/* 6.10 Entity instance aggregate operations */
 
DAI_EXPORT SdaiInteger sdaiGetMemberCount(SdaiAggr aggregate);
 
DAI_EXPORT SdaiIterator sdaiCreateIterator(SdaiAggr aggregate);
 
DAI_EXPORT void sdaiDeleteIterator(SdaiIterator iterator);
 
DAI_EXPORT void sdaiBeginning(SdaiIterator iterator);
 
DAI_EXPORT SdaiBoolean sdaiNext(SdaiIterator iterator);
 
DAI_EXPORT void* sdaiGetAggrByIterator(SdaiIterator iterator, SdaiPrimitiveType valueType, void *value);
 
 
 
/* ODA SDAI extension functions */
 
DAI_EXPORT SdaiRep _sdaiCreateRepository(SdaiSession session, SdaiString name);
 
DAI_EXPORT SdaiRep _sdaiCreateRepositoryFromFile(SdaiSession session, SdaiString fileName, SdaiString name);
 
DAI_EXPORT SdaiAppInstance _sdaiGetEntityById(SdaiModel model, SdaiInteger id);
 
DAI_EXPORT SdaiInteger _sdaiGetEntityId(SdaiAppInstance entInst);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // _SDAI_