A3DSDKBim.h
Types
Functions
Detailed Description
- Author
Tech Soft 3D
- Version
23.1
- Date
April 2023
- Copyright (c) 2010 - 2023 by Tech Soft 3D, Inc. All rights reserved.
Function Documentation
-
A3DStatus A3DBIMDataGet(const A3DBIMData *pDBIMData, A3DBIMDataData *pData)
Retrieves data of an
A3DBIMData
entity.In case of success, the
pData
contains heap allocated memory your are responsible for. To free the memory onpData
, callA3DBIMDataGet
withpDBIMData
set to 0.- Version
14.2
- Memory Management
See also
- Parameters
pDBIMData – [in] The BIM Data entity to get data from
pData – [out] A pointer to the data structure to fill in
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity type
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DBIMRelContainedInSpatialStructureGet(const A3DBIMRelContainedInSpatialStructure *pRelationship, A3DBIMRelContainedInSpatialStructureData *pData)
Retrieves the data of an
A3DBIMRelContainedInSpatialStructure
entity.In case of success, the
pData
contains heap allocated memory your are responsible for. To free the memory onpData
, callA3DBIMRelContainedInSpatialStructureGet
withpRelationship
set to 0.- Version
14.2
- Memory Management
See also
- Parameters
pRelationship – [in] The relationship entity to get data from
pData – [out] A pointer to the data structure to fill in
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity type
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DBIMRelFillsElementGet(const A3DBIMRelFillsElement *pRelationship, A3DBIMRelFillsElementData *pData)
Retrieves the data of an
A3DBIMRelFillsElement
entity.In case of success, the
pData
contains heap allocated memory your are responsible for. To free the memory onpData
, callA3DBIMRelFillsElementGet
withpRelationship
set to 0.- Version
14.2
- Memory Management
See also
See also
- Parameters
pRelationship – [in] The relationship entity to get data from
pData – [out] A pointer to the data structure to fill in
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity type
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DBIMRelSpaceBoundaryGet(const A3DBIMRelSpaceBoundary *pRelationship, A3DBIMRelSpaceBoundaryData *pData)
Retrieves the data of an
A3DBIMRelSpaceBoundary
entity.In case of success, the
pData
contains heap allocated memory your are responsible for. To free the memory onpData
, callA3DBIMRelSpaceBoundaryGet
withpRelationship
set to 0.- Version
14.2
- Memory Management
See also
See also
- Parameters
pRelationship – [in] The relationship entity to get data from
pData – [out] A pointer to the data structure to fill in
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity type
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DBIMRelAggregatesGet(const A3DBIMRelAggregates *pRelationship, A3DBIMRelAggregatesData *pData)
Retrieves the data of an
A3DBIMRelAggregates
entity.In case of success, the
pData
contains heap allocated memory your are responsible for. To free the memory onpData
, callA3DBIMRelAggregatesGet
withpRelationship
set to 0.- Version
14.2
- Memory Management
See also
See also
- Parameters
pRelationship – [in] The relationship entity to get data from
pData – [out] A pointer to the data structure to fill in
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity type
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DBIMRelVoidsElementGet(const A3DBIMRelVoidsElement *pRelationship, A3DBIMRelVoidsElementData *pData)
Retrieves the data of an
A3DBIMRelVoidsElement
entity.In case of success, the
pData
contains heap allocated memory your are responsible for. To free the memory onpData
, callA3DBIMRelVoidsElementGet
withpRelationship
set to 0.- Version
14.2
- Memory Management
See also
See also
- Parameters
pRelationship – [in] The relationship entity to get data from
pData – [out] A pointer to the data structure to fill in
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity type
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DBIMRelConnectsPathElementsGet(const A3DBIMRelConnectsPathElements *pRelationship, A3DBIMRelConnectsPathElementsData *pData)
Retrieves the data of an
A3DBIMRelConnectsPathElements
entity.In case of success, the
pData
contains heap allocated memory your are responsible for. To free the memory onpData
, callA3DBIMRelConnectsPathElementsGet
withpRelationship
set to 0.- Version
14.2
- Memory Management
See also
See also
- Parameters
pRelationship – [in] The relationship entity to get data from
pData – [out] A pointer to the data structure to fill in
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity type
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DBIMRootGet(const A3DBIMRoot *pRoot, A3DBIMRootData *pData)
Retrieves the data of an
A3DBIMRoot
entity.In case of success, the
pData
contains heap allocated memory your are responsible for. To free the memory onpData
, callA3DBIMRootGet
withpRelationship
set to 0.- Version
14.2
- Memory Management
See also
See also
- Parameters
pRoot – [in] The relationship entity to get data from
pData – [out] A pointer to the data structure to fill in
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity type
- Returns
A3D_SUCCESS in case of success or an error code
-
A3DStatus A3DAsmModelFileExportToIfcXMLFile(const A3DAsmModelFile *pA3DAsmModelFile, const A3DUTF8Char *pcXMLFileName)
Exports all the BIM data of a given model file into an XML file.
- Parameters
pA3DAsmModelFile – [in] The model file to export BIM data from
pcXMLFileName – [out] A valid path to a non existing file
- Return values
A3D_SUCCESS – In case of success.
A3D_INITIALIZE_NOT_CALLED – if the library is not initialized.
A3D_INVALID_DATA_STRUCT_NULL – if
pData
is nullA3D_INVALID_DATA_STRUCT_SIZE – if
pData
is incorrectly initializedA3D_INVALID_ENTITY_NULL – if
pDBIMData
is nullA3D_INVALID_ENTITY_TYPE – if
pdBIMData
references an invalid entity typeA3D_BIMDATA_EMPTY – if the model file contains no BIM Data
- Returns
A3D_SUCCESS or an error code