OpenCascade.jsAPIHeaderSection
OCCT package APIHeaderSection: APIHeaderSection_EditHeader, APIHeaderSection_MakeHeader.
APIHeaderSection_EditHeader
Constructors(1)
Static methods(2)
- get_type_name(): string
Instance methods(1)
APIHeaderSection_MakeHeader
This class allows to consult and prepare/edit data stored in a Step Model Header.
Constructors(2)
- constructor(shapetype?: number): APIHeaderSection_MakeHeader
Prepares a new MakeHeader from scratch.
Parameters (1)shapetype
Prepares a MakeHeader from the content of a StepModel See IsDone to know if the Header is well defined.
Parameters (1)model
Instance methods(43)
- Init(nameval: string): void
Cancels the former definition and gives a FileName To be used when a Model has no well defined Header.
Parameters (1)nameval
- IsDone(): boolean
Returns True if all data have been defined (see also HasFn, HasFs, HasFd).
- Apply(model: StepData_StepModel): void
Creates an empty header for a new STEP model and allows the header fields to be completed.
Parameters (1)model
- NewModel(protocol: Interface_Protocol): StepData_StepModel
Builds a Header, creates a new StepModel, then applies the Header to the StepModel The Schema Name is taken from the Protocol (if it inherits from
StepData, else it is left in blanks).Parameters (1)protocol
- HasFn(): boolean
Checks whether there is a file_name entity. Returns True if there is one.
- FnValue(): unknown
Returns the file_name entity. Returns an empty entity if the file_name entity is not initialized.
- SetName(aName: TCollection_HAsciiString): voidParameters (1)
aName
Returns the name attribute for the file_name entity.
- SetTimeStamp(aTimeStamp: TCollection_HAsciiString): voidParameters (1)
aTimeStamp
Returns the value of the time_stamp attribute for the file_name entity.
- SetAuthor(aAuthor: NCollection_HArray1_handle_TCollection_HAsciiString): voidParameters (1)
aAuthor
- SetAuthorValue(num: number, aAuthor: TCollection_HAsciiString): voidParameters (2)
numaAuthor
- AuthorValue(num: number): TCollection_HAsciiString
Returns the value of the name attribute for the file_name entity.
Parameters (1)num
- NbAuthor(): number
Returns the number of values for the author attribute in the file_name entity.
- SetOrganization(aOrganization: NCollection_HArray1_handle_TCollection_HAsciiString): voidParameters (1)
aOrganization
- SetOrganizationValue(num: number, aOrganization: TCollection_HAsciiString): voidParameters (2)
numaOrganization
- OrganizationValue(num: number): TCollection_HAsciiString
Returns the value of attribute organization for the file_name entity.
Parameters (1)num
- NbOrganization(): number
Returns the number of values for the organization attribute in the file_name entity.
- SetPreprocessorVersion(aPreprocessorVersion: TCollection_HAsciiString): voidParameters (1)
aPreprocessorVersion
Returns the name of the preprocessor_version for the file_name entity.
- SetOriginatingSystem(aOriginatingSystem: TCollection_HAsciiString): voidParameters (1)
aOriginatingSystem
- SetAuthorisation(aAuthorisation: TCollection_HAsciiString): voidParameters (1)
aAuthorisation
Returns the value of the authorization attribute for the file_name entity.
- HasFs(): boolean
Checks whether there is a file_schema entity. Returns True if there is one.
- FsValue(): unknown
Returns the file_schema entity. Returns an empty entity if the file_schema entity is not initialized.
- SetSchemaIdentifiers(aSchemaIdentifiers: NCollection_HArray1_handle_TCollection_HAsciiString): voidParameters (1)
aSchemaIdentifiers
- SetSchemaIdentifiersValue(num: number, aSchemaIdentifier: TCollection_HAsciiString): voidParameters (2)
numaSchemaIdentifier
- SchemaIdentifiersValue(num: number): TCollection_HAsciiString
Returns the value of the schema_identifier attribute for the file_schema entity.
Parameters (1)num
- NbSchemaIdentifiers(): number
Returns the number of values for the schema_identifier attribute in the file_schema entity.
- AddSchemaIdentifier(aSchemaIdentifier: TCollection_HAsciiString): void
Add a subname of schema (if not yet in the list).
Parameters (1)aSchemaIdentifier
- HasFd(): boolean
Checks whether there is a file_description entity. Returns True if there is one.
- FdValue(): unknown
Returns the file_description entity. Returns an empty entity if the file_description entity is not initialized.
- SetDescription(aDescription: NCollection_HArray1_handle_TCollection_HAsciiString): voidParameters (1)
aDescription
- SetDescriptionValue(num: number, aDescription: TCollection_HAsciiString): voidParameters (2)
numaDescription
- DescriptionValue(num: number): TCollection_HAsciiString
Returns the value of the description attribute for the file_description entity.
Parameters (1)num
- NbDescription(): number
Returns the number of values for the file_description entity in the STEP file header.
- SetImplementationLevel(aImplementationLevel: TCollection_HAsciiString): voidParameters (1)
aImplementationLevel
Returns the value of the implementation_level attribute for the file_description entity.