StepSelect

OCCT package StepSelect: StepSelect_Activator, StepSelect_FileModifier, StepSelect_FloatFormat, StepSelect_ModelModifier, and 2 more bound classes.

StepSelect_Activator

IFSelect_ActivatorStandard_Transient

Performs Actions specific to StepSelect, i.e. creation of Step Selections and Counters, plus dumping specific to Step.

Constructors(1)

constructor(): StepSelect_Activator

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(3)

Do(number_: number, pilot: IFSelect_SessionPilot): IFSelect_ReturnStatus
Executes a Command Line for StepSelect.
Parameters (2)
- number_
- pilot
Help(number_: number): string
Sends a short help message for StepSelect commands.
Parameters (1)
- number_
DynamicType(): Standard_Type

StepSelect_FileModifier

IFSelect_GeneralModifierStandard_Transient

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(2)

Perform(ctx: IFSelect_ContextWrite, writer: StepData_StepWriter): void
Perform the action specific to each class of File Modifier <ctx> is the ContextWrite, which brings : the model, the protocol, the file name, plus the object AppliedModifiers (not used here) and the CheckList Remark that the model has to be casted for specific access.
<writer> is the Writer and is specific to each norm, on which to act
Parameters (2)
- ctx
- writer
DynamicType(): Standard_Type

StepSelect_FloatFormat

StepSelect_FileModifierIFSelect_GeneralModifierStandard_Transient

This class gives control out format for floatting values : ZeroSuppress or no, Main Format, Format in Range (for values around 1.), as StepWriter allows to manage it. Formats are given under C-printf form.

Constructors(1)

constructor(): StepSelect_FloatFormat
Creates a new FloatFormat, with standard options : ZeroSuppress, Main Format = E, Format between 0.001 and 1000. = f.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(8)

SetDefault(digits?: number): void
Sets FloatFormat to default value (see Create) but if <digits> is given positive, it commands Formats (main and range) to ensure <digits> significant digits to be displayed.
Parameters (1)
- digits
SetZeroSuppress(mode: boolean): void
Sets ZeroSuppress mode to a new value.
Parameters (1)
- mode
SetFormat(format?: string): void
Sets Main Format to a new value Remark : SetFormat, SetZeroSuppress and SetFormatForRange are independent.
Parameters (1)
- format
SetFormatForRange(format?: string, Rmin?: number, Rmax?: number): void
Sets Format for Range to a new value with its range of application. To cancel it, give format as "" (empty string) Remark that if the condition (0. < Rmin < Rmax) is not verified, this secondary format will be ignored. Moreover, this secondary format is intended to be used in a range around 1.
Parameters (3)
- format
- Rmin
- Rmax
Format(zerosup: boolean, mainform: TCollection_AsciiString, hasrange: boolean, forminrange: TCollection_AsciiString, rangemin: number, rangemax: number): { zerosup: boolean; hasrange: boolean; rangemin: number; rangemax: number }
Returns all recorded parameters : zerosup : ZeroSuppress status mainform : Main Format (which applies out of the range, or for every real if no range is set) hasrange : True if a FormatInRange is set, False else (following parameters do not apply if it is False) forminrange : Secondary Format (it applies inside the range) rangemin, rangemax : the range in which the secondary format applies.
Parameters (6)
- zerosup
- mainform —
  Mutated in place; read the updated value from this argument after the call.
- hasrange
- forminrange —
  Mutated in place; read the updated value from this argument after the call.
- rangemin
- rangemax
Returns
A result object with fields:
- zerosup: updated value from the call.
- hasrange: updated value from the call.
- rangemin: updated value from the call.
- rangemax: updated value from the call.
Perform(ctx: IFSelect_ContextWrite, writer: StepData_StepWriter): void
Sets the Floatting Formats of StepWriter to the recorded parameters.
Parameters (2)
- ctx
- writer
Label(): TCollection_AsciiString
Returns specific Label : for instance, "Float Format [ZeroSuppress] %E [, in range R1-R2 %f]".
DynamicType(): Standard_Type

StepType is a Signature specific to Step definitions : it considers the type as defined in STEP Schemas, the same which is used in files. For a Complex Type, if its definition is known, StepType produces the list of basic types, separated by commas, the whole between brackets : "(TYPE1,TYPE2..)". If its precise definition is not known (simply it is known as Complex, it can be recognised, but the list is produced at Write time only), StepType produces : "(..COMPLEX TYPE..)".

Constructors(1)

constructor(): StepSelect_StepType
Creates a Signature for Step Type. Protocol is undefined here, hence no Signature may yet be produced. The StepType signature requires a Protocol before working.

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(3)

SetProtocol(proto: Interface_Protocol): void
Sets the StepType signature to work with a Protocol : this initialises the library.
Parameters (1)
- proto
Value(ent: Standard_Transient, model: Interface_InterfaceModel): string
Returns the Step Type defined from the Protocol (see above). If <ent> is not recognised, produces "..NOT FROM SCHEMA <name>..".
Parameters (2)
- ent
- model
DynamicType(): Standard_Type

StepSelect_WorkLibrary

IFSelect_WorkLibraryStandard_Transient

Performs Read and Write a STEP File with a STEP Model Following the protocols, Copy may be implemented or not.

Constructors(1)

constructor(copymode?: boolean): StepSelect_WorkLibrary
Creates a STEP WorkLibrary <copymode> precises whether Copy is implemented or not.
Parameters (1)
- copymode

Static methods(2)

get_type_name(): string
get_type_descriptor(): Standard_Type

Instance methods(4)

SetDumpLabel(mode: number): void
Selects a mode to dump entities 0 (D) : prints numbers, then displays table number/label 1 : prints labels, then displays table label/number 2 : prints labels onky.
Parameters (1)
- mode
ReadFile(name: string, protocol: Interface_Protocol): { returnValue: number; model: Interface_InterfaceModel; [Symbol.dispose](): void }
Reads a STEP File and returns a STEP Model (into <mod>), or lets <mod> "Null" in case of Error Returns 0 if OK, 1 if Read Error, -1 if File not opened.
Parameters (2)
- name
- protocol
Returns
A result object with fields:
- returnValue: the C++ return value
- model: owned by the returned envelope.
  Dispose the returned envelope to release owned Handle fields.
WriteFile(ctx: IFSelect_ContextWrite): boolean
Writes a File from a STEP Model Returns False (and writes no file) if <ctx> does not bring a STEP Model.
Parameters (1)
- ctx
DynamicType(): Standard_Type

Constructors(1)

Static methods(2)

Instance methods(3)

Static methods(2)

Instance methods(2)

Constructors(1)

Static methods(2)

Instance methods(8)

Static methods(1)

Instance methods(1)

Constructors(1)

Static methods(2)

Instance methods(3)

Constructors(1)

Static methods(2)

Instance methods(4)