BcfToolsModule.h File Reference

#include "OdPlatformSettings.h"
#include "IfcBuildOptions.h"
#include "RxModule.h"
#include "SmartPtr.h"

Go to the source code of this file.

Classes
class	OdBcfTools::OdBcfToolsModule

Namespaces
namespace	OdBcfTools

Typedefs
typedef OdSmartPtr< OdBcfToolsModule >	OdBcfTools::OdBcfToolsModulePtr

Enumerations
enum	BcfVersion { kVersionBcfUndefined = 0 , kVersionBcf_2_1 = 1 , kVersionBcf_3_0 = 2 , kVersionBcfAll = 4 }

Functions
BCFTOOLS_EXPORT OdResult	odBcfToolsInitialize (BcfVersion version=kVersionBcfUndefined)
BCFTOOLS_EXPORT OdResult	odBcfToolsUninitialize ()

Enumeration Type Documentation

BcfVersion

enum BcfVersion

Enumeration for modules initialization modes.

Enumerator
kVersionBcfUndefined	No BCF data module is initialized
kVersionBcf_2_1	BCF 2.1 data module is initialized.
kVersionBcf_3_0	BCF 3.0 data module is initialized.
kVersionBcfAll	All BCF data modules are initialized.

Definition at line 36 of file BcfToolsModule.h.

Function Documentation

odBcfToolsInitialize()

BCFTOOLS_EXPORT OdResult odBcfToolsInitialize

(

BcfVersion

version = kVersionBcfUndefined

)

Initializes BCF SDK functionality.

Parameters

version

[in] A BCF version(s) to be initialized.

Returns

eOk if BCF 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.

odBcfToolsUninitialize()

BCFTOOLS_EXPORT OdResult odBcfToolsUninitialize

(

)

De-initializes BCF SDK functionality.

Returns

Returns eOk if BCF 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 BCF-related modules are loaded, the function returns the eNullPtr error code.