getHeader method

  1. @override
PIInstance getHeader()

Gets the header instance containing model metadata.

This method retrieves the header instance that contains essential metadata about the model, including file description, naming information, and schema details. The header follows the ISO 10303-21 (STEP) file structure and is typically created during model initialization.

The header instance contains three main attributes:

  1. file_description - Implementation level and description
  2. file_name - Name, timestamp, author, organization, and system information
  3. file_schema - Schema identifiers and version information

See IModelExtension.createHeader for details on how the header structure is created and the specific information captured in each attribute.

Returns the header IInstance if it exists, or null instance.

Implementation

@override
PIInstance getHeader() {
  final instStruct = _getHeader(projectPtr, ptr);
  return PIInstance.fromInstanceStruct(instStruct);
}