HM_ExtAPI::CADDocumentGetType()

Returns the type of the model assembly hierarchy document.

Syntax

bool CADDocumentGetType(
const HM_CAD_Document & doc,
HM_ExtAPI::DocType & doc_type
);

Type

HyperMesh Ext API Function

Description

Type classification of the model assembly hierarchy documents reflects the difference between model parts that contain actual geometry data and assemblies containing references to different parts or sub-assemblies along with corresponding transformations to the global model coordinates system.

If the function succeeds, the return value is true. If the function fails, the return value is false. To get extended value information, call HM_ExtAPI::GetLastErrorCode().

Different CAD systems use different name conventions to distinguish between two types of model hierarchy documents. The following table type translation for the CAD systems supported within API.
CAD System Assembly Part
HM_ExtAPI DOC_ASSEMBLY DOC_PART
CATIA CATProduct CATPart

Requires including hm_extapi.h.

Inputs

doc
[in] - Handle to document object that was returned by previous calls to API functions.
doc_type
[out] - Document type. When function returns, this parameter can have one of following values.
HM_ExtAPI::DOC_ASSEMBLY - The document represents the assembly from original CAD model.
HM_ExtAPI::DOC_PART - The document represents the part from original CAD model.
HM_ExtAPI::NOT_A_DOC - The handle was not recognized as a valid document handle.

Errors

None.