bhm0GetModelOrgData API

This is a server API that returns the model organization data that is saved in the model object in Teamcenter. The model organization data consists of a model folder name, relative paths of all the submodel files, and model-configured data. This API is available for the Bhm0BehaviorModelRevision and Bhm0CompRepositoryRevision objects and all inherited business objects.

The model organization information is returned for the model object on which the API is invoked. To obtain the organization information for all the submodels, the API should be invoked recursively on all the submodels.

int bhm0GetModelOrgData ( behaviormodeling::BhmModelOrgDataS *modelOrgData )

Inputs

• BhmModelOrgDataS — Specifies a reference to an empty BhmModelOrgDataS structure object. The API returns model organization data in this input structure object.

Outputs

The API outputs the model organization data in the BhmModelOrgDataS structure object, which returns:

Output object	Description
modelName	Specifies the name of the model.
modelFolderPath	Specifies the model path relative to the model folder.
configFilesFolderPath	Specifies the paths of the configuration data files relative to the model, including the name of the file.
mapSubModelFilesFolderPath	Specifies the submodel name and its path relative to the parent model excluding the submodel folder name.

Example

Note: The source page illustrates this with a folder-hierarchy diagram and an accompanying results table; the diagram itself did not extract as readable text and the resulting table came through with some formatting loss. The gist, preserved faithfully below, is that invoking the API on a parent model returns its own modelName/modelFolderPath/configFilesFolderPath plus a map of each direct submodel's identifier to its relative folder path — and the same API must be invoked again on each submodel to walk further down the hierarchy.

Example output objects observed in the source (for a ModelParent00 hierarchy containing submodels ModelSub01, ModelSub02, and ModelParent11 which itself contains ModelSub12):

• modelName: ModelParent00 — modelFolderPath: 00_modelParent-a01-00-a — configFilesFolderPath includes entries like ./const/SomeDataModel.mat, ./simdata/SimDataSpec.doc, ./pic/SimResult.jpg, ./extern/ExternDataModel.m — mapSubModelFilesFolderPath: ModelSub01, ModelSub02, ModelParent11 each mapped to their relative paths.
• modelName: ModelSub02 — modelFolderPath: 02_modelSub2-a01-00-a — similar configFilesFolderPath entries — no further submodels.
• modelName: ModelParent11 — modelFolderPath: 11_modelParent-a01-00-a — similar configFilesFolderPath entries — mapSubModelFilesFolderPath: ModelSub12.
• modelName: ModelSub12 — modelFolderPath: 12_modelSub1-a01-00-a — similar configFilesFolderPath entries.