CFx SDK Documentation  2022 SP0
Classes | Macros | Typedefs | Enumerations | Functions
sdai.h File Reference
#include "daiError/daiErrorId.h"
#include "daiBuildOptions.h"

Go to the source code of this file.

Classes

struct  Sdai_instS
 
struct  Sdai_aggrS
 

Macros

#define sdaiFALSE   0
 
#define sdaiTRUE   1
 
#define sdaiUNKNOWN   2
 
#define sdaiBIT0   '0'
 
#define sdaiBIT1   '1'
 
#define sdaiE   2.7182818284590451353602874713
 
#define sdaiPI   3.1415926353897932384626433832
 

Typedefs

typedef struct Sdai_instSSdaiId
 
typedef struct Sdai_Id_aggr * SdaiId_aggr
 
typedef struct Sdai_ItrId * SdaiItrId
 
typedef struct Sdai_ADBId * SdaiADBId
 
typedef unsigned SdaiIndexId
 
typedef unsigned char SdaiBit
 
typedef long SdaiInteger
 
typedef double SdaiReal
 
typedef SdaiReal SdaiNumber
 
typedef int SdaiBoolean
 
typedef int SdaiLogical
 
typedef char * SdaiString
 
typedef SdaiBitSdaiBinary
 
typedef char * SdaiEnum
 
typedef SdaiId_aggr SdaiAggr
 
typedef SdaiAggr SdaiOrderedAggr
 
typedef SdaiAggr SdaiUnorderedAggr
 
typedef SdaiOrderedAggr SdaiArray
 
typedef SdaiOrderedAggr SdaiList
 
typedef SdaiUnorderedAggr SdaiSet
 
typedef SdaiUnorderedAggr SdaiBag
 
typedef SdaiId SdaiInstance
 
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 SdaiInstance SdaiWhereRule
 
typedef SdaiInstance SdaiUniRule
 
typedef SdaiInstance SdaiGlobalRule
 
typedef SdaiInstance SdaiSchema
 
typedef SdaiInstance SdaiScope
 
typedef SdaiInstance SdaiSchemaInstance
 
typedef SdaiInstance SdaiTrx
 
typedef SdaiItrId SdaiIterator
 
typedef SdaiADBId SdaiADB
 
typedef SdaiIndexId SdaiAggrIndex
 
typedef SdaiErrorId SdaiErrorCode
 
typedef void(* SdaiErrorHandler) (SdaiErrorCode)
 

Enumerations

enum  SdaiPrimitiveType {
  sdaiADB , sdaiAGGR , sdaiBINARY , sdaiBOOLEAN ,
  sdaiENUM , sdaiINSTANCE , sdaiINTEGER , sdaiLOGICAL ,
  sdaiNOTYPE , sdaiNUMBER , sdaiREAL , sdaiSTRING
}
 
enum  SdaiQuerySourceType { sdaiQUERY_AGGR , sdaiQUERY_MODEL , sdaiQUERY_REP , sdaiQUERY_SCHEMAINSTANCE }
 
enum  SdaiAccessMode { Access_type_unset , sdaiRO , sdaiRW }
 

Functions

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)
 
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 SdaiLogical sdaiIsRecordingOn (SdaiSession session)
 
DAI_EXPORT SdaiADB sdaiCreateADB (SdaiPrimitiveType valueType,...)
 
DAI_EXPORT SdaiADB sdaiCreateEmptyADB (void)
 
DAI_EXPORT voidsdaiGetADBValue (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)
 
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)
 
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 SdaiSchema sdaiGetSchema (SdaiString schemaName)
 
DAI_EXPORT SdaiSchemaInstance sdaiGetSchemaInstance (SdaiString schemaInstanceName, SdaiRep repository)
 
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 sdaiCreateComplexInstanceBN (SdaiModel model, SdaiInteger nameNumber, SdaiString *nameVector)
 
DAI_EXPORT SdaiSet sdaiGetEntityExtent (SdaiModel model, SdaiEntity entity)
 
DAI_EXPORT SdaiSet sdaiGetEntityExtentBN (SdaiModel model, SdaiString name)
 
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)
 
DAI_EXPORT voidsdaiGetAttr (SdaiInstance instance, SdaiAttr attribute, SdaiPrimitiveType valueType, void *value)
 
DAI_EXPORT voidsdaiGetAttrBN (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)
 
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 SdaiADBsdaiGetAllAttrs (SdaiInstance instance, SdaiInteger *numberAttr)
 
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)
 
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 voidsdaiGetAggrByIterator (SdaiIterator iterator, SdaiPrimitiveType valueType, void *value)
 
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)
 

Macro Definition Documentation

◆ sdaiBIT0

#define sdaiBIT0   '0'

Definition at line 85 of file sdai.h.

◆ sdaiBIT1

#define sdaiBIT1   '1'

Definition at line 86 of file sdai.h.

◆ sdaiE

#define sdaiE   2.7182818284590451353602874713

Definition at line 90 of file sdai.h.

◆ sdaiFALSE

#define sdaiFALSE   0

Definition at line 79 of file sdai.h.

◆ sdaiPI

#define sdaiPI   3.1415926353897932384626433832

Definition at line 91 of file sdai.h.

◆ sdaiTRUE

#define sdaiTRUE   1

Definition at line 80 of file sdai.h.

◆ sdaiUNKNOWN

#define sdaiUNKNOWN   2

Definition at line 81 of file sdai.h.

Typedef Documentation

◆ SdaiADB

typedef SdaiADBId SdaiADB

C late binding ADB identifier type:

Definition at line 303 of file sdai.h.

◆ SdaiADBId

typedef struct Sdai_ADBId* SdaiADBId

The C late binding type of the type SdaiADB is represented by an implementation specific handle named SdaiADBId

Definition at line 67 of file sdai.h.

◆ SdaiAggr

The C late binding representation of any aggregate instance is defined by the instance identifier type SdaiInstance and is named SdaiAggr

Definition at line 144 of file sdai.h.

◆ SdaiAggrIndex

aggregate index data type:

Definition at line 308 of file sdai.h.

◆ SdaiAppInstance

application instance

Definition at line 200 of file sdai.h.

◆ SdaiArray

array instance

Definition at line 159 of file sdai.h.

◆ SdaiAttr

attribute

Definition at line 220 of file sdai.h.

◆ SdaiBag

bag instance

Definition at line 174 of file sdai.h.

◆ SdaiBinary

typedef SdaiBit* SdaiBinary

The EXPRESS BINARY data type shall be represented by the C late binding data type

Definition at line 133 of file sdai.h.

◆ SdaiBit

typedef unsigned char SdaiBit

Definition at line 96 of file sdai.h.

◆ SdaiBoolean

typedef int SdaiBoolean

The EXPRESS BOOLEAN data type shall be represented by the C late binding data type

Definition at line 118 of file sdai.h.

◆ SdaiEntity

entity definition

Definition at line 235 of file sdai.h.

◆ SdaiEnum

typedef char* SdaiEnum

Definition at line 136 of file sdai.h.

◆ SdaiErrorCode

error code data type:

Definition at line 313 of file sdai.h.

◆ SdaiErrorHandler

typedef void(* SdaiErrorHandler) (SdaiErrorCode)

error handler data type:

Definition at line 318 of file sdai.h.

◆ SdaiExplicitAttr

explicit attribute

Definition at line 225 of file sdai.h.

◆ SdaiGlobalRule

global rule

Definition at line 255 of file sdai.h.

◆ SdaiId

typedef struct Sdai_instS* SdaiId

The value of an attribute or aggregate element that is an instance of an EXPRESS ENTITY type is represented by an implementation specific handle named SdaiId

Definition at line 50 of file sdai.h.

◆ SdaiId_aggr

typedef struct Sdai_Id_aggr* SdaiId_aggr

Definition at line 55 of file sdai.h.

◆ SdaiIndexId

typedef unsigned SdaiIndexId

The data type SdaiAggrIndex is used to represent aggregation indices. The C late binding type of SdaiAggrIndex is represented by an implementation specific handle named SdaiIndexId

Definition at line 73 of file sdai.h.

◆ SdaiInstance

The handle serves as the identifier of the instance. Identifiers are not persistent. Identifiers shall be unique globally over all types of instances and unchanging within an SDAI session for any particular instance.

Definition at line 193 of file sdai.h.

◆ SdaiInteger

typedef long SdaiInteger

The EXPRESS INTEGER data type shall be represented by the C late binding data type

Definition at line 103 of file sdai.h.

◆ SdaiIterator

SDAI iterator identifier type

Definition at line 281 of file sdai.h.

◆ SdaiItrId

typedef struct Sdai_ItrId* SdaiItrId

The SDAI iterator data type providing access to aggregate members is represented by an implementation specific handle named SdaiItrId

Definition at line 61 of file sdai.h.

◆ SdaiList

list instance

Definition at line 164 of file sdai.h.

◆ SdaiLogical

typedef int SdaiLogical

The EXPRESS LOGICAL data type shall be represented by the C late binding data type

Definition at line 123 of file sdai.h.

◆ SdaiModel

sdai model

Definition at line 205 of file sdai.h.

◆ SdaiNamedType

named type

Definition at line 230 of file sdai.h.

◆ SdaiNumber

The EXPRESS NUMBER data type shall be represented by the C late binding data type

Definition at line 113 of file sdai.h.

◆ SdaiOrderedAggr

ordered collection

Definition at line 149 of file sdai.h.

◆ SdaiReal

typedef double SdaiReal

The EXPRESS REAL data type shall be represented by the C late binding data type

Definition at line 108 of file sdai.h.

◆ SdaiRep

sdai repository

Definition at line 210 of file sdai.h.

◆ SdaiSchema

sdai schema

Definition at line 260 of file sdai.h.

◆ SdaiSchemaInstance

sdai schema instance

Definition at line 270 of file sdai.h.

◆ SdaiScope

sdai scope

Definition at line 265 of file sdai.h.

◆ SdaiSession

sdai session

Definition at line 215 of file sdai.h.

◆ SdaiSet

set instance

Definition at line 169 of file sdai.h.

◆ SdaiString

typedef char* SdaiString

The EXPRESS STRING data type shall be represented by the C late binding data type

Definition at line 128 of file sdai.h.

◆ SdaiTrx

sdai transaction

Definition at line 275 of file sdai.h.

◆ SdaiUniRule

uniqueness rule

Definition at line 250 of file sdai.h.

◆ SdaiUnorderedAggr

unordered collection

Definition at line 154 of file sdai.h.

◆ SdaiWhereRule

where rule

Definition at line 245 of file sdai.h.

Enumeration Type Documentation

◆ SdaiAccessMode

access mode data type:

Enumerator
Access_type_unset 
sdaiRO 
sdaiRW 

Definition at line 298 of file sdai.h.

◆ SdaiPrimitiveType

attribute type data type

Enumerator
sdaiADB 
sdaiAGGR 
sdaiBINARY 
sdaiBOOLEAN 
sdaiENUM 
sdaiINSTANCE 
sdaiINTEGER 
sdaiLOGICAL 
sdaiNOTYPE 
sdaiNUMBER 
sdaiREAL 
sdaiSTRING 

Definition at line 179 of file sdai.h.

◆ SdaiQuerySourceType

Query source data type:

Enumerator
sdaiQUERY_AGGR 
sdaiQUERY_MODEL 
sdaiQUERY_REP 
sdaiQUERY_SCHEMAINSTANCE 

Definition at line 290 of file sdai.h.

Function Documentation

◆ _sdaiCreateRepository()

DAI_EXPORT SdaiRep _sdaiCreateRepository ( SdaiSession  session,
SdaiString  name 
)

Creates a new repository with desired name inside current session.

Parameters
session[in] session instance
name[in] new repository name
Returns
instance of the created repository, in other case NULL

◆ _sdaiCreateRepositoryFromFile()

DAI_EXPORT SdaiRep _sdaiCreateRepositoryFromFile ( SdaiSession  session,
SdaiString  fileName,
SdaiString  name 
)

Creates a new repository inside current session.

Parameters
session[in] session instance
fileName[in] file name
name[in] repository name
Remarks
If the name is empty (""), the fileName becomes a newly created repository name. If the file stores several data section (file_description.implementation_level is "3" or higher), every model gets the name predefined in file, otherwise (file_description.implementation_level is 2 ("2;1", "2;2"), the single model will have name "default".
Returns
instance of the created repository, in other case NULL

◆ _sdaiGetEntityById()

DAI_EXPORT SdaiAppInstance _sdaiGetEntityById ( SdaiModel  model,
SdaiInteger  id 
)

Returns entity by ID

Parameters
model[in] model where entity from
id[in] is entity ID
Returns
an entity instance by its step-id, or null if there is no entity with such id in the model. In error case appropriate error codes should be logged

◆ _sdaiGetEntityId()

DAI_EXPORT SdaiInteger _sdaiGetEntityId ( SdaiAppInstance  entInst)

Returns entity ID

Parameters
entInst[in] entity instance
Returns
a step-id of an entity instance

◆ sdaiAccessModel()

DAI_EXPORT SdaiModel sdaiAccessModel ( SdaiModel  model,
SdaiAccessMode  mode 
)

◆ sdaiAccessModelBN()

DAI_EXPORT SdaiModel sdaiAccessModelBN ( SdaiRep  repository,
SdaiString  modelName,
SdaiAccessMode  mode 
)

◆ sdaiAddModel()

DAI_EXPORT void sdaiAddModel ( SdaiSchemaInstance  schemaInstance,
SdaiModel  model 
)

◆ sdaiAddModelBN()

DAI_EXPORT void sdaiAddModelBN ( SdaiSchemaInstance  schemaInstance,
SdaiRep  repository,
SdaiString  modelName 
)

◆ sdaiBeginning()

DAI_EXPORT void sdaiBeginning ( SdaiIterator  iterator)

Sets the position of iterator to the begginning of aggregate instance.

Parameters
iterator[in] An iterator to set the position.

◆ sdaiCloseRepository()

DAI_EXPORT void sdaiCloseRepository ( SdaiRep  repository)

◆ sdaiCloseSession()

DAI_EXPORT void sdaiCloseSession ( SdaiSession  session)

◆ sdaiCreateADB()

DAI_EXPORT SdaiADB sdaiCreateADB ( SdaiPrimitiveType  valueType,
  ... 
)

◆ sdaiCreateAggr()

DAI_EXPORT SdaiAggr sdaiCreateAggr ( SdaiAppInstance  instance,
SdaiExplicitAttr  attribute 
)

◆ sdaiCreateAggrADB()

DAI_EXPORT SdaiAggr sdaiCreateAggrADB ( SdaiAppInstance  instance,
SdaiExplicitAttr  attribute,
SdaiADB  selaggrInstance 
)

◆ sdaiCreateAggrADBBN()

DAI_EXPORT SdaiAggr sdaiCreateAggrADBBN ( SdaiAppInstance  instance,
SdaiString  attributeName,
SdaiADB  selaggrInstance 
)

◆ sdaiCreateAggrBN()

DAI_EXPORT SdaiAggr sdaiCreateAggrBN ( SdaiAppInstance  instance,
SdaiString  attributeName 
)

◆ sdaiCreateComplexInstanceBN()

DAI_EXPORT SdaiAppInstance sdaiCreateComplexInstanceBN ( SdaiModel  model,
SdaiInteger  nameNumber,
SdaiString nameVector 
)

◆ sdaiCreateEmptyADB()

DAI_EXPORT SdaiADB sdaiCreateEmptyADB ( void  )

◆ sdaiCreateInstance()

DAI_EXPORT SdaiAppInstance sdaiCreateInstance ( SdaiModel  model,
SdaiEntity  entity 
)

◆ sdaiCreateInstanceBN()

DAI_EXPORT SdaiAppInstance sdaiCreateInstanceBN ( SdaiModel  model,
SdaiString  entityName 
)

◆ sdaiCreateIterator()

DAI_EXPORT SdaiIterator sdaiCreateIterator ( SdaiAggr  aggregate)

Creates an iterator for traversing aggregate elements.

Remarks
Returned object should be deleted by user.
Parameters
aggregate[in] An aggregate for traversing.

◆ sdaiCreateModel()

DAI_EXPORT SdaiModel sdaiCreateModel ( SdaiRep  repository,
SdaiString  modelName,
SdaiSchema  schema 
)

◆ sdaiCreateModelBN()

DAI_EXPORT SdaiModel sdaiCreateModelBN ( SdaiRep  repository,
SdaiString  modelName,
SdaiString  schemaName 
)

◆ sdaiCreateSchemaInstance()

DAI_EXPORT SdaiSchemaInstance sdaiCreateSchemaInstance ( SdaiString  schemaInstanceName,
SdaiSchema  schema,
SdaiRep  repository 
)

◆ sdaiCreateSchemaInstanceBN()

DAI_EXPORT SdaiSchemaInstance sdaiCreateSchemaInstanceBN ( SdaiString  schemaInstanceName,
SdaiString  schemaName,
SdaiRep  repository 
)

◆ sdaiDeleteADB()

DAI_EXPORT void sdaiDeleteADB ( SdaiADB  block)

◆ sdaiDeleteInstance()

DAI_EXPORT void sdaiDeleteInstance ( SdaiAppInstance  instance)

◆ sdaiDeleteIterator()

DAI_EXPORT void sdaiDeleteIterator ( SdaiIterator  iterator)

Deletes an iterator.

Parameters
iterator[in] Iterator to delete.

◆ sdaiDeleteModel()

DAI_EXPORT void sdaiDeleteModel ( SdaiModel  model)

◆ sdaiDeleteModelBN()

DAI_EXPORT void sdaiDeleteModelBN ( SdaiRep  repository,
SdaiString  modelName 
)

◆ sdaiDeleteSchemaInstance()

DAI_EXPORT void sdaiDeleteSchemaInstance ( SdaiSchemaInstance  schemaInstance)

◆ sdaiDeleteSchemaInstanceBN()

DAI_EXPORT void sdaiDeleteSchemaInstanceBN ( SdaiString  schemaInstanceName,
SdaiRep  repository 
)

◆ sdaiEndModelAccess()

DAI_EXPORT void sdaiEndModelAccess ( SdaiModel  model)

◆ sdaiErrorQuery()

DAI_EXPORT SdaiErrorCode sdaiErrorQuery ( void  )

The Error Query function shall return the error code resulting from the C binding function that most recently executed unsuccessfully

Remarks
After returning the error code, subsequent executions of the ErrorQuery function shall return sdaiNO_ERR until another C language binding function executes unsuccessfully. Prior to executing the Open Session function, the Error Query function shall return sdaiSS_NOPN.

Possible error indicators: sdaiSS_NOPN Session is not open.

Returns
Standard error code: The error code of the most recent function that executed unsuccessfully.

◆ sdaiFarCopyInstance()

DAI_EXPORT SdaiAppInstance sdaiFarCopyInstance ( SdaiAppInstance  instance,
SdaiModel  model 
)

◆ sdaiGetADBType()

DAI_EXPORT SdaiPrimitiveType sdaiGetADBType ( SdaiADB  block)

◆ sdaiGetADBValue()

DAI_EXPORT void* sdaiGetADBValue ( SdaiADB  block,
SdaiPrimitiveType  valueType,
void value 
)

◆ sdaiGetAggrByIterator()

DAI_EXPORT void* sdaiGetAggrByIterator ( SdaiIterator  iterator,
SdaiPrimitiveType  valueType,
void value 
)

Retrueves the value of current iterator element.

Parameters
iterator[in] Iterator to get value from.
valueType[in] The desired type of the value to get.
value[out] A pointer to the place in memory to set the value.

◆ sdaiGetAllAttrs()

DAI_EXPORT SdaiADB* sdaiGetAllAttrs ( SdaiInstance  instance,
SdaiInteger numberAttr 
)

◆ sdaiGetAttr()

DAI_EXPORT void* sdaiGetAttr ( SdaiInstance  instance,
SdaiAttr  attribute,
SdaiPrimitiveType  valueType,
void value 
)

◆ sdaiGetAttrBN()

DAI_EXPORT void* sdaiGetAttrBN ( SdaiInstance  instance,
SdaiString  attributeName,
SdaiPrimitiveType  valueType,
void value 
)

◆ sdaiGetAttrDefinition()

DAI_EXPORT SdaiAttr sdaiGetAttrDefinition ( SdaiEntity  entity,
SdaiString  attrName 
)

◆ sdaiGetAttrDefinitionBN()

DAI_EXPORT SdaiAttr sdaiGetAttrDefinitionBN ( SdaiString  schemaName,
SdaiString  entityName,
SdaiString  attrName 
)

◆ sdaiGetAttrs()

DAI_EXPORT void sdaiGetAttrs ( SdaiInstance  instance,
SdaiInteger  numberAttr,
SdaiAttr  attribute,
SdaiPrimitiveType  valueType,
void value,
  ... 
)

◆ sdaiGetAttrsBN()

DAI_EXPORT void sdaiGetAttrsBN ( SdaiInstance  instance,
SdaiInteger  numberAttr,
SdaiString  attributeName,
SdaiPrimitiveType  valueType,
void value,
  ... 
)

◆ sdaiGetEntity()

DAI_EXPORT SdaiEntity sdaiGetEntity ( SdaiModel  model,
SdaiString  name 
)

Returns an entity definition for the specified entity name.

◆ sdaiGetEntityExtent()

DAI_EXPORT SdaiSet sdaiGetEntityExtent ( SdaiModel  model,
SdaiEntity  entity 
)

Retreives a collection of entity instances that are subtypes of entity type described by entity definition.

Parameters
model[in] The model to get entities collection from.
entity[in] The entity definition to find entity instances.
Returns
A set of entity instances of type which is derived from entity.

◆ sdaiGetEntityExtentBN()

DAI_EXPORT SdaiSet sdaiGetEntityExtentBN ( SdaiModel  model,
SdaiString  name 
)

Retreives a collection of entity instances that are subtypes of entity type.

Parameters
model[in] The model to get entities collection from.
entity[in] The entity definition to find entity instances.
Returns
A set of entity instances of type which is derived from entity.

◆ sdaiGetInstanceModel()

DAI_EXPORT SdaiModel sdaiGetInstanceModel ( SdaiInstance  instance)

◆ sdaiGetInstanceType()

DAI_EXPORT SdaiEntity sdaiGetInstanceType ( SdaiInstance  instance)

◆ sdaiGetMemberCount()

DAI_EXPORT SdaiInteger sdaiGetMemberCount ( SdaiAggr  aggregate)

Returns a number of elements contained in aggregate.

Parameters
aggregate[in] An aggregate to get number of elements.

◆ sdaiGetSchema()

DAI_EXPORT SdaiSchema sdaiGetSchema ( SdaiString  schemaName)

◆ sdaiGetSchemaInstance()

DAI_EXPORT SdaiSchemaInstance sdaiGetSchemaInstance ( SdaiString  schemaInstanceName,
SdaiRep  repository 
)

◆ sdaiIsEqual()

DAI_EXPORT SdaiBoolean sdaiIsEqual ( SdaiInstance  instance1,
SdaiInstance  instance2 
)

The Is Equal function shall test whether the two specified SDAI identifiers are identical.

Parameters
instance1[in] The first identifier in the comparison.
instance2[in] The second identifier in the comparison.
Returns
In normal condition: sdaiTRUE if instance1 and instance2 are equal; sdaiFALSE if instance1 and instance2 are not equal.

◆ sdaiIsInstanceOf()

DAI_EXPORT SdaiBoolean sdaiIsInstanceOf ( SdaiInstance  instance,
SdaiEntity  entity 
)

◆ sdaiIsInstanceOfBN()

DAI_EXPORT SdaiBoolean sdaiIsInstanceOfBN ( SdaiInstance  instance,
SdaiString  entityName 
)

◆ sdaiIsKindOf()

DAI_EXPORT SdaiBoolean sdaiIsKindOf ( SdaiInstance  instance,
SdaiEntity  entity 
)

◆ sdaiIsKindOfBN()

DAI_EXPORT SdaiBoolean sdaiIsKindOfBN ( SdaiInstance  instance,
SdaiString  entityName 
)

◆ sdaiIsRecordingOn()

DAI_EXPORT SdaiLogical sdaiIsRecordingOn ( SdaiSession  session)

◆ sdaiIsSDAIKindOf()

DAI_EXPORT SdaiBoolean sdaiIsSDAIKindOf ( SdaiInstance  instance,
SdaiEntity  entity 
)

◆ sdaiIsSDAIKindOfBN()

DAI_EXPORT SdaiBoolean sdaiIsSDAIKindOfBN ( SdaiInstance  instance,
SdaiString  entityName 
)

◆ sdaiIsSDAISubtypeOf()

DAI_EXPORT SdaiBoolean sdaiIsSDAISubtypeOf ( SdaiEntity  subtype,
SdaiEntity  supertype 
)

◆ sdaiIsSDAISubtypeOfBN()

DAI_EXPORT SdaiBoolean sdaiIsSDAISubtypeOfBN ( SdaiString  schemaName,
SdaiString  subName,
SdaiString  superName 
)

◆ sdaiIsSubtypeOf()

DAI_EXPORT SdaiBoolean sdaiIsSubtypeOf ( SdaiEntity  subtype,
SdaiEntity  supertype 
)

The Is Subtype Of function shall determine whether an entity definition is a subtype of another entity definition.

Parameters
subtype[in] subtype to check
supertype[in] supertype to check
Returns
sdaiTRUE if supertype is supertype of subtype, in other case sdaiFALSE

◆ sdaiIsSubtypeOfBN()

DAI_EXPORT SdaiBoolean sdaiIsSubtypeOfBN ( SdaiString  schemaName,
SdaiString  subName,
SdaiString  superName 
)

The Is Subtype Of function shall determine whether an entity definition is a subtype of another entity definition.

Parameters
schemaName[in] schema name
subName[in] name of subtype
superName[in] name of supertype
Returns
sdaiTRUE if supertype is supertype of subtype, in other case sdaiFALSE

◆ sdaiLogicalCompare()

DAI_EXPORT int sdaiLogicalCompare ( SdaiLogical  value1,
SdaiLogical  value2 
)

The Logical Compare function shall test for the ordering of two values according to the ordering of the values of the EXPRESS LOGICAL data type.

Parameters
value1[in] value to compare.
value2[in] value to compare.
Returns
In normal condition: +1 if value1 is greater than value2; 0 if value1 is equal to value2; -1 if value1 is less than value2.

◆ sdaiNearCopyInstance()

DAI_EXPORT SdaiAppInstance sdaiNearCopyInstance ( SdaiAppInstance  instance)

◆ sdaiNext()

DAI_EXPORT SdaiBoolean sdaiNext ( SdaiIterator  iterator)

Moves the position of iterator to the next element in aggregate instance.

Parameters
iterator[in] An iterator to set the position.

◆ sdaiOpenRepository()

DAI_EXPORT SdaiRep sdaiOpenRepository ( SdaiSession  session,
SdaiRep  repository 
)

◆ sdaiOpenRepositoryBN()

DAI_EXPORT SdaiRep sdaiOpenRepositoryBN ( SdaiSession  session,
SdaiString  repositoryName 
)

◆ sdaiOpenSession()

DAI_EXPORT SdaiSession sdaiOpenSession ( void  )

The Open Session function shall initiate the SDAI implementation and start a new SDAI session.

Remarks
Possible error indicators: sdaiSS_OPN Session open. sdaiSS_NAVL SDAI not available. sdaiSY_ERR Underlying system error.
Returns
In normal condition: Session instance identifier. In error condition: NULL identifier.

◆ sdaiPromoteModel()

DAI_EXPORT void sdaiPromoteModel ( SdaiModel  model)

◆ sdaiPutADBValue()

DAI_EXPORT void sdaiPutADBValue ( SdaiADB  block,
SdaiPrimitiveType  valueType,
  ... 
)

◆ sdaiPutAttr()

DAI_EXPORT void sdaiPutAttr ( SdaiAppInstance  instance,
SdaiExplicitAttr  attribute,
SdaiPrimitiveType  valueType,
  ... 
)

◆ sdaiPutAttrBN()

DAI_EXPORT void sdaiPutAttrBN ( SdaiAppInstance  instance,
SdaiString  attributeName,
SdaiPrimitiveType  valueType,
  ... 
)

◆ sdaiRecordEvent()

DAI_EXPORT void sdaiRecordEvent ( SdaiSession  session,
SdaiString  functionName,
SdaiErrorCode  error,
SdaiString  description 
)

◆ sdaiRemoveModel()

DAI_EXPORT void sdaiRemoveModel ( SdaiSchemaInstance  schemaInstance,
SdaiModel  model 
)

◆ sdaiRemoveModelBN()

DAI_EXPORT void sdaiRemoveModelBN ( SdaiSchemaInstance  schemaInstance,
SdaiRep  repository,
SdaiString  modelName 
)

◆ sdaiRenameModel()

DAI_EXPORT void sdaiRenameModel ( SdaiModel  model,
SdaiString  modelName 
)

◆ sdaiRenameModelBN()

DAI_EXPORT void sdaiRenameModelBN ( SdaiRep  repository,
SdaiString  modelOldName,
SdaiString  modelName 
)

◆ sdaiRenameSchemaInstance()

DAI_EXPORT void sdaiRenameSchemaInstance ( SdaiSchemaInstance  schemaInst,
SdaiString  schemaInstName 
)

◆ sdaiRenameSchemaInstanceBN()

DAI_EXPORT void sdaiRenameSchemaInstanceBN ( SdaiString  schemaInstOldName,
SdaiRep  repository,
SdaiString  schemaInstName 
)

◆ sdaiRestoreErrorHandler()

DAI_EXPORT SdaiErrorHandler sdaiRestoreErrorHandler ( void  )

The Restore Error Handler function shall remove the most recently added error handling function from the top of the last in, first out error handler stack.

Remarks
The next most recently added error handling function is left at the top of the error handler stack. This function has no effect if the error handler stack is empty.

◆ sdaiSaveChanges()

DAI_EXPORT void sdaiSaveChanges ( SdaiModel  model)

◆ sdaiSetErrorHandler()

DAI_EXPORT void sdaiSetErrorHandler ( SdaiErrorHandler  function)

The Set Error Handler function shall place the specified error handling function on the last in, first out error handler stack.

Remarks
This function shall accept the error code as the only parameter and may be executed before the Open Session function, during an SDAI session, and after the Close Session function. The system default error handler may be placed on the stack by specifying a NULL function. Multiple error handling functions may be placed on the stack. The most recently added error handling function is at the top of the stack and shall automatically be invoked when an error condition occurs.

Possible error indicators: sdaiSY_ERR Underlying system error

◆ sdaiSetEventRecording()

DAI_EXPORT SdaiBoolean sdaiSetEventRecording ( SdaiSession  session,
SdaiBoolean  setRec 
)

◆ sdaiTestAttr()

DAI_EXPORT SdaiBoolean sdaiTestAttr ( SdaiInstance  instance,
SdaiAttr  attribute 
)

Determines if the value of attribute is unset.

Parameters
instance[in] The instance of the entity whose attribute is being tested.
attribute[in] An SdaiAttr instance from the SDAI dictionary.
Returns
sdaiTRUE if the attribute has a value or sdaiFALSE if the attribute value is not set.

◆ sdaiTestAttrBN()

DAI_EXPORT SdaiBoolean sdaiTestAttrBN ( SdaiInstance  instance,
SdaiString  attributeName 
)

Determines if the value of attribute is unset.

Parameters
instance[in] The instance of the entity whose attribute is being tested.
attributeName[in] The name of the attribute being tested.
Returns
sdaiTRUE if the attribute has a value or sdaiFALSE if the attribute value is not set.

◆ sdaiUndoChanges()

DAI_EXPORT void sdaiUndoChanges ( SdaiModel  model)

◆ sdaiUnsetADB()

DAI_EXPORT void sdaiUnsetADB ( SdaiADB  block)

◆ sdaiUnsetAttr()

DAI_EXPORT void sdaiUnsetAttr ( SdaiAppInstance  instance,
SdaiExplicitAttr  attribute 
)

Restores the state of the specified attribute in the specified application instance such it has no value.

Parameters
instance[in] The application instance whose attribute is to be unset.
attribute[in] An attribute definition from the data dictionary.

◆ sdaiUnsetAttrBN()

DAI_EXPORT void sdaiUnsetAttrBN ( SdaiAppInstance  instance,
SdaiString  attributeName 
)

Restores the state of the specified attribute in the specified application instance such it has no value.

Parameters
instance[in] The application instance whose attribute is to be unset.
attributeName[in] The name of the attribute to be unset.