CFx SDK Documentation  2023 SP0
Namespaces | Classes | Typedefs | Enumerations | Functions
OdDAI Namespace Reference

Namespaces

 Consts
 
 Utils
 
 WrUtils
 

Classes

class  AggrInstance
 
class  AggrInstanceTyped
 
class  AggrBase
 
class  Aggr
 
class  OdBaseType
 
class  OdBooleanType
 
class  DictionaryInstance
 
class  OdEntityExtent
 
class  EntityInstance
 
class  OdEnum
 
class  BaseException
 
class  daiBaseEvent
 
class  daiErrorEvent
 
class  daiErrorHandlerBase
 
class  daiErrorHandlerManager
 
class  DaiException
 
class  UserException
 
class  OdFileDescriptionAuto
 
class  OdFileNameAuto
 
class  OdFileSchemaAuto
 
class  OdHeaderSection
 
class  InstanceIterator
 
class  OdIntegerType
 
class  Iterator
 
class  IteratorArr
 
class  Model
 
class  OdSDAIModule
 
class  OdNamedType
 
class  OdSpfEnum
 
class  OdLogical
 
class  OdRealType
 
class  Repository
 
class  OdSelect
 
class  Session
 
class  SessionInstance
 
class  OdSimpleType
 
class  OdStringType
 

Typedefs

typedef Aggr< bool > BoolAggr
 
typedef OdSharedPtr< BoolAggrBoolAggrPtr
 
typedef Aggr< double > DoubleAggr
 
typedef OdSharedPtr< DoubleAggrDoubleAggrPtr
 
typedef Aggr< int > IntAggr
 
typedef OdSharedPtr< IntAggrIntAggrPtr
 
typedef Aggr< OdDAIObjectIdOdDAIObjectIdAggr
 
typedef OdSharedPtr< OdDAIObjectIdAggrOdDAIObjectIdAggrPtr
 
typedef OdSmartPtr< OdBaseTypeOdBaseTypePtr
 
typedef std::map< std::string, OdBaseTypePtrOdBaseTypeDictionary
 
typedef OdSmartPtr< OdBooleanTypeOdBooleanTypePtr
 
typedef OdSmartPtr< DictionaryInstanceDictionaryInstancePtr
 
typedef OdSmartPtr< OdEntityExtentOdEntityExtentPtr
 
typedef OdSmartPtr< Attribute > AttributePtr
 
typedef OdSmartPtr< EntityInstanceEntityInstancePtr
 
typedef OdSharedPtr< daiBaseEventdaiBaseEventPtr
 
typedef OdSharedPtr< daiErrorEventdaiErrorEventPtr
 
typedef OdSharedPtr< daiErrorHandlerBasedaiErrorHandlerPtr
 
typedef unsigned int daiErrorId
 
typedef OdAnsiString SchemaName
 
typedef OdSmartPtr< OdHeaderSectionOdHeaderSectionPtr
 
typedef OdSmartPtr< OdSpfFilerBase > OdSpfFilerBasePtr
 
typedef OdSharedPtr< InstanceIteratorInstanceIteratorPtr
 
typedef OdSmartPtr< OdIntegerTypeOdIntegerTypePtr
 
typedef OdSharedPtr< IteratorIteratorPtr
 
typedef OdSmartPtr< ModelContents > ModelContentsPtr
 
typedef OdSmartPtr< ModelModelPtr
 
typedef OdSmartPtr< OdSDAIModuleOdSDAIModulePtr
 
typedef OdSmartPtr< OdNamedTypeOdNamedTypePtr
 
typedef OdSmartPtr< EntityInstanceWrapper > EntityInstanceWrapperPtr
 
typedef OdAnsiString BINARY
 
typedef OdSmartPtr< OdRealTypeOdRealTypePtr
 
typedef OdSmartPtr< Schema > SchemaPtr
 
typedef OdSmartPtr< RepositoryRepositoryPtr
 
typedef OdSmartPtr< SessionSessionPtr
 
typedef OdSmartPtr< SessionInstanceSessionInstancePtr
 
typedef OdSmartPtr< OdSimpleTypeOdSimpleTypePtr
 
typedef OdSmartPtr< OdStringTypeOdStringTypePtr
 

Enumerations

enum  NullModelAction { exceptionAction , assertApproveAccessAction , silentApproveAccessAction }
 
enum  OdHeaderEntityType { kFileDescription , kFileName , kFileSchema , kAny }
 
enum  OpenMode { kNotOpen = -1 , kForRead = 0 }
 
enum  OdLogical_ { k_F , k_T , k_unset , k_U }
 

Functions

void checkReadMode (const Model *model, const char *functionName, NullModelAction nullModelAction=exceptionAction)
 
void checkWriteMode (const Model *model, const char *functionName, NullModelAction nullModelAction=exceptionAction)
 
void checkReadModePtr (const ModelPtr &model, const char *functionName, NullModelAction modelAction=exceptionAction)
 
void checkWriteModePtr (const ModelPtr &model, const char *functionName, NullModelAction modelAction=exceptionAction)
 
DAI_EXPORT const char * errorToDescription (daiErrorId errorId)
 
EntityInstancePtr daiHeaderCreateImplFromName (const char *className)
 
EntityInstancePtr daiHeaderCreateImplFromType (OdHeaderEntityType ifcEntityType)
 
bool DAI_EXPORT daiHeaderEntityTypeToStr (OdHeaderEntityType type, OdAnsiString &res)
 
bool DAI_EXPORT daiHeaderEntityTypeBase (OdHeaderEntityType type, OdHeaderEntityType &baseType)
 
void daiHeaderRxClassesInit ()
 
void daiHeaderRxClassesUninit ()
 
bool DAI_EXPORT operator== (const OdFileDescriptionAuto &left, const OdFileDescriptionAuto &right)
 
bool DAI_EXPORT operator== (const OdFileNameAuto &left, const OdFileNameAuto &right)
 
bool DAI_EXPORT operator== (const OdFileSchemaAuto &left, const OdFileSchemaAuto &right)
 
bool DAI_EXPORT operator== (const OdDAI::OdSelect &left, const OdDAI::OdSelect &right)
 
bool DAI_EXPORT operator!= (const OdDAI::OdSelect &left, const OdDAI::OdSelect &right)
 

Detailed Description

Implements the Data Access Interface (DAI) that provides functionality for manipulating data that is defined within the EXPRESS SCHEMA format.

The namespace contains schema-dependent classes, definitions and sub routines for work with DAI_HEADER express schema definitions.

Typedef Documentation

◆ AttributePtr

typedef OdSmartPtr<Attribute> OdDAI::AttributePtr

Definition at line 41 of file daiEntityInstance.h.

◆ BINARY

typedef OdAnsiString OdDAI::BINARY

Definition at line 94 of file daiPrimitive.h.

◆ BoolAggr

typedef Aggr< bool > OdDAI::BoolAggr

Definition at line 216 of file daiAggr.h.

◆ BoolAggrPtr

Definition at line 217 of file daiAggr.h.

◆ daiBaseEventPtr

Definition at line 42 of file baseException.h.

◆ daiErrorEventPtr

Definition at line 37 of file daiErrorEvent.h.

◆ daiErrorHandlerPtr

Definition at line 38 of file daiErrorHandlerBase.h.

◆ daiErrorId

typedef unsigned int OdDAI::daiErrorId

Definition at line 90 of file daiErrorId.h.

◆ DictionaryInstancePtr

Definition at line 54 of file daiDictionaryInstance.h.

◆ DoubleAggr

typedef Aggr< double > OdDAI::DoubleAggr

Definition at line 219 of file daiAggr.h.

◆ DoubleAggrPtr

Definition at line 220 of file daiAggr.h.

◆ EntityInstancePtr

A data type that represents a smart pointer to an <link OdDAI::EntityInstance, EntityInstance> object.

Definition at line 221 of file daiEntityInstance.h.

◆ EntityInstanceWrapperPtr

typedef OdSmartPtr<EntityInstanceWrapper> OdDAI::EntityInstanceWrapperPtr

Definition at line 39 of file daiObjectId.h.

◆ InstanceIteratorPtr

A data type that represents a smart pointer to an <link OdDAI::InstanceIterator, InstanceIterator> object.

Definition at line 68 of file daiInstanceIterator.h.

◆ IntAggr

typedef Aggr< int > OdDAI::IntAggr

Definition at line 222 of file daiAggr.h.

◆ IntAggrPtr

Definition at line 223 of file daiAggr.h.

◆ IteratorPtr

Definition at line 57 of file daiIterator.h.

◆ ModelContentsPtr

typedef OdSmartPtr<ModelContents> OdDAI::ModelContentsPtr

Definition at line 48 of file daiModel.h.

◆ ModelPtr

Definition at line 57 of file daiModel.h.

◆ OdBaseTypeDictionary

Definition at line 46 of file daiBaseType.h.

◆ OdBaseTypePtr

Definition at line 45 of file daiBaseType.h.

◆ OdBooleanTypePtr

Definition at line 44 of file daiBooleanType.h.

◆ OdDAIObjectIdAggr

Definition at line 225 of file daiAggr.h.

◆ OdDAIObjectIdAggrPtr

Definition at line 226 of file daiAggr.h.

◆ OdEntityExtentPtr

Definition at line 95 of file daiEntityExtent.h.

◆ OdHeaderSectionPtr

A data type that represents a smart pointer to an <link OdDAI::OdHeaderSection, OdHeaderSection> object.

Definition at line 39 of file daiHeaderSection.h.

◆ OdIntegerTypePtr

A data type that represents a smart pointer to an <link OdDAI::OdIntegerType, OdIntegerType> object.

Definition at line 56 of file daiIntegerType.h.

◆ OdNamedTypePtr

Definition at line 52 of file daiNamedType.h.

◆ OdRealTypePtr

Definition at line 56 of file daiRealType.h.

◆ OdSDAIModulePtr

A data type that represents a smart pointer to an <link OdDAI::OdSDAIModule, OdSDAIModule> object.

Definition at line 98 of file daiModule.h.

◆ OdSimpleTypePtr

Definition at line 43 of file daiSimpleType.h.

◆ OdSpfFilerBasePtr

typedef OdSmartPtr< OdSpfFilerBase > OdDAI::OdSpfFilerBasePtr

Definition at line 42 of file daiHeaderSection.h.

◆ OdStringTypePtr

Definition at line 45 of file daiStringType.h.

◆ RepositoryPtr

Definition at line 213 of file daiRepository.h.

◆ SchemaName

typedef OdAnsiString OdDAI::SchemaName

Definition at line 36 of file daiHeaderSimpleTypes.h.

◆ SchemaPtr

typedef OdSmartPtr<Schema> OdDAI::SchemaPtr

Definition at line 51 of file daiRepository.h.

◆ SessionInstancePtr

Definition at line 46 of file daiSessionInstance.h.

◆ SessionPtr

Definition at line 102 of file daiSession.h.

Enumeration Type Documentation

◆ NullModelAction

Enumerator
exceptionAction 
assertApproveAccessAction 
silentApproveAccessAction 

Definition at line 32 of file daiAccessDefines.h.

◆ OdHeaderEntityType

Enumerator
kFileDescription 
kFileName 
kFileSchema 
kAny 

Definition at line 31 of file daiHeaderEntityTypes.h.

◆ OdLogical_

Enumerator
k_F 
k_T 
k_unset 
k_U 

Definition at line 40 of file daiPrimitive.h.

◆ OpenMode

Object open modes.

Enumerator
kNotOpen 
kForRead 

Definition at line 52 of file daiObjectId.h.

Function Documentation

◆ checkReadMode()

void OdDAI::checkReadMode ( const Model model,
const char *  functionName,
NullModelAction  nullModelAction = exceptionAction 
)
inline

Definition at line 40 of file daiAccessDefines.h.

◆ checkReadModePtr()

void OdDAI::checkReadModePtr ( const ModelPtr model,
const char *  functionName,
NullModelAction  modelAction = exceptionAction 
)
inline

Definition at line 103 of file daiAccessDefines.h.

◆ checkWriteMode()

void OdDAI::checkWriteMode ( const Model model,
const char *  functionName,
NullModelAction  nullModelAction = exceptionAction 
)
inline

Definition at line 71 of file daiAccessDefines.h.

◆ checkWriteModePtr()

void OdDAI::checkWriteModePtr ( const ModelPtr model,
const char *  functionName,
NullModelAction  modelAction = exceptionAction 
)
inline

Definition at line 108 of file daiAccessDefines.h.

◆ daiHeaderCreateImplFromName()

EntityInstancePtr OdDAI::daiHeaderCreateImplFromName ( const char *  className)

◆ daiHeaderCreateImplFromType()

EntityInstancePtr OdDAI::daiHeaderCreateImplFromType ( OdHeaderEntityType  ifcEntityType)

◆ daiHeaderEntityTypeBase()

bool DAI_EXPORT OdDAI::daiHeaderEntityTypeBase ( OdHeaderEntityType  type,
OdHeaderEntityType baseType 
)

◆ daiHeaderEntityTypeToStr()

bool DAI_EXPORT OdDAI::daiHeaderEntityTypeToStr ( OdHeaderEntityType  type,
OdAnsiString &  res 
)

◆ daiHeaderRxClassesInit()

void OdDAI::daiHeaderRxClassesInit ( )

◆ daiHeaderRxClassesUninit()

void OdDAI::daiHeaderRxClassesUninit ( )

◆ errorToDescription()

DAI_EXPORT const char* OdDAI::errorToDescription ( daiErrorId  errorId)

◆ operator!=()

bool DAI_EXPORT OdDAI::operator!= ( const OdDAI::OdSelect left,
const OdDAI::OdSelect right 
)

◆ operator==() [1/4]

bool DAI_EXPORT OdDAI::operator== ( const OdDAI::OdSelect left,
const OdDAI::OdSelect right 
)

◆ operator==() [2/4]

bool DAI_EXPORT OdDAI::operator== ( const OdFileDescriptionAuto left,
const OdFileDescriptionAuto right 
)

◆ operator==() [3/4]

bool DAI_EXPORT OdDAI::operator== ( const OdFileNameAuto left,
const OdFileNameAuto right 
)

◆ operator==() [4/4]

bool DAI_EXPORT OdDAI::operator== ( const OdFileSchemaAuto left,
const OdFileSchemaAuto right 
)