CFx SDK Documentation  2020SP3
Classes | Namespaces | Typedefs | Enumerations | Functions
IfcCore.h File Reference
#include "daiModule.h"
#include "IfcBuildOptions.h"
#include "IfcValueTypes.h"
#include "IfcSchemaModule.h"

Go to the source code of this file.

Classes

class  OdIfc::OdIfcCoreModule
 

Namespaces

 OdIfc
 

Typedefs

typedef OdSmartPtr< OdIfcCoreModule > OdIfc::OdIfcCoreModulePtr
 

Enumerations

enum  InitialSchema { kScmUndefined = 0, kScmIfc2x3 = 1, kScmIfc4 = 2, kScmIfc4x2 = 3 }
 
enum  ModelerType { kFacetModeler, kSpaModeler, kBrepModeler }
 

Functions

IFCCORE_EXPORT OdResult odIfcInitialize (bool bInitIfcGeomResource=true, ModelerType modelerType=kFacetModeler)
 
IFCCORE_EXPORT OdResult odIfcUninitialize ()
 
IFCCORE_EXPORT bool odIfcIsGeomResourceInitialized ()
 

Enumeration Type Documentation

◆ InitialSchema

Enumeration for default database content initialization modes.

Enumerator
kScmUndefined 

Database content is not initialized.

kScmIfc2x3 

Default database content has the Ifc2x3 version.

kScmIfc4 

Default database content has the Ifc4 version.

kScmIfc4x2 

Default database content has the Ifc4x2 version.

Definition at line 41 of file IfcCore.h.

◆ ModelerType

Defines available modeler types

Enumerator
kFacetModeler 
kSpaModeler 
kBrepModeler 

Definition at line 56 of file IfcCore.h.

Function Documentation

◆ odIfcInitialize()

IFCCORE_EXPORT OdResult odIfcInitialize ( bool  bInitIfcGeomResource = true,
ModelerType  modelerType = kFacetModeler 
)

Initializes IFC SDK functionality.

Parameters
bInitIfcGeomResource[in] A flag that determines whether geometry resources are initialized as well (if equal to true) or not (if equal to false).
modelerType[in] Modeler type which will be used to create geometry.
Returns
Returns eOk if IFC SDK was successfully initialized; otherwise, the function returns an appropriate error code.
Remarks
The function checks whether all needed modules are loaded and loads them if they are not. If at least one of the necessary modules is not loaded, the function returns the eNullPtr error code. It the bInitIfcGeomResource parameter value is equal to false, the IFC geometry library is unavailable, therefore the model cannot be visualized. In this mode only data management functionality is available.

◆ odIfcIsGeomResourceInitialized()

IFCCORE_EXPORT bool odIfcIsGeomResourceInitialized ( )

Retrieves whether the IFC geometry module is loaded and initialized.

Returns
The function returns true if the IFC geometry module is initialized; otherwise, the function returns false.

◆ odIfcUninitialize()

IFCCORE_EXPORT OdResult odIfcUninitialize ( )

De-initializes IFC SDK functionality.

Returns
Returns eOk if IFC SDK was successfully de-initialized; otherwise, the function returns an appropriate error code.
Remarks
The function checks whether the needed modules are loaded and decreases the reference counters for them. If a reference counter for any appropriate module becomes equal to zero, the function unloads the module. If no IFC-related modules are loaded, the function returns the eNullPtr error code.