OCC.Core.StepData module

StepData module, see official documentation at https://www.opencascade.com/doc/occt-7.4.0/refman/html/package_stepdata.html

class StepData_Array1OfField(*args)

Bases: object

Assign()

ChangeFirst()

ChangeLast()

ChangeValue()

First()

Init()

IsAllocated()

IsDeletable()

IsEmpty()

Last()

Length()

Lower()

Move()

Resize()

Set()

SetValue()

Size()

Upper()

Value()

begin()

cbegin()

cend()

end()

next()

property thisown

The membership flag

class StepData_DefaultGeneral(*args)

Bases: OCC.Core.StepData.StepData_GeneralModule

• Creates a Default General Module

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class StepData_Described(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

As()

• Returns a Simple Entity which matches with a Type in <self>For a Simple Entityme if it matches, else a null handle For a Complex Entitythe member which matches, else null

  param steptype

  type steptype

  char *

  rtype

  opencascade::handle<StepData_Simple>

CField()

• Returns a Field from its name; read or write

  param name

  type name

  char *

  rtype

  StepData_Field

Check()

• Fills a Check by using its Description

  param ach

  type ach

  Interface_Check

  rtype

  void

Description()

• Returns the Description used to define this entity

  rtype

  opencascade::handle<StepData_EDescr>

static DownCast(t)

Field()

• Returns a Field from its name; read-only

  param name

  type name

  char *

  rtype

  StepData_Field

HasField()

• Tells if a Field brings a given name

  param name

  type name

  char *

  rtype

  bool

IsComplex()

• Tells if a described entity is complex

  rtype

  bool

Matches()

• Tells if a step type is matched by <self> For a Simple Entityown type or super type For a Complex Entityone of the members

  param steptype

  type steptype

  char *

  rtype

  bool

Shared()

• Fills an EntityIterator with entities shared by <self>

  param list

  type list

  Interface_EntityIterator

  rtype

  void

property thisown

The membership flag

class StepData_ECDescr(*args)

Bases: OCC.Core.StepData.StepData_EDescr

• Creates an ECDescr, empty

  rtype

  None

Add()

• Adds a member Warningmembers are added in alphabetic order

  param member

  type member

  StepData_ESDescr

  rtype

  None

static DownCast(t)

Member()

• Returns a Member from its rank

  param num

  type num

  int

  rtype

  opencascade::handle<StepData_ESDescr>

NbMembers()

• Returns the count of members

  rtype

  int

TypeList()

• Returns the ordered list of types

  rtype

  opencascade::handle<TColStd_HSequenceOfAsciiString>

property thisown

The membership flag

class StepData_EDescr(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

IsComplex()

• Tells if a EDescr is complex (ECDescr) or simple (ESDescr)

  rtype

  bool

Matches()

• Tells if a ESDescr matches a step typeexact or super type

  param steptype

  type steptype

  char *

  rtype

  bool

NewEntity()

• Creates a described entity (i.e. a simple one)

  rtype

  opencascade::handle<StepData_Described>

property thisown

The membership flag

class StepData_ESDescr(*args)

Bases: OCC.Core.StepData.StepData_EDescr

• Creates an ESDescr with a type name

  param name

  type name

  char *

  rtype

  None

Base()

• Returns the basic ESDescr, null if <self> is not derived

  rtype

  opencascade::handle<StepData_ESDescr>

static DownCast(t)

Field()

• Returns the PDescr for the field <num> (or Null)

  param num

  type num

  int

  rtype

  opencascade::handle<StepData_PDescr>

IsSub()

• Tells if <self> is sub-type of (or equal to) another one

  param other

  type other

  StepData_ESDescr

  rtype

  bool

Name()

• Returns the name of a field from its rank. empty if outofrange

  param num

  type num

  int

  rtype

  char *

NamedField()

• Returns the PDescr for the field named <name> (or Null)

  param name

  type name

  char *

  rtype

  opencascade::handle<StepData_PDescr>

NbFields()

• Returns the count of fields

  rtype

  int

Rank()

• Returns the rank of a field from its name. 0 if unknown

  param name

  type name

  char *

  rtype

  int

SetBase()

• Sets an ESDescr as based on another one Hence, if there are inherited fields, the derived ESDescr cumulates all them, while the base just records its own ones

  param base

  type base

  StepData_ESDescr

  rtype

  None

SetField()

• Sets a PDescr to describe a field A Field is designated by its rank and name

  param num

  type num

  int

  param name

  type name

  char *

  param descr

  type descr

  StepData_PDescr

  rtype

  None

SetNbFields()

• Sets a new count of fields Each one is described by a PDescr

  param nb

  type nb

  int

  rtype

  None

SetSuper()

• Sets an ESDescr as ‘super-type’. Applies an a base (non derived) ESDescr

  param super

  type super

  StepData_ESDescr

  rtype

  None

StepType()

• Returns the type name as an AsciiString

  rtype

  TCollection_AsciiString

Super()

• Returns the super-type ESDescr, null if <self> is root

  rtype

  opencascade::handle<StepData_ESDescr>

TypeName()

• Returns the type name given at creation time

  rtype

  char *

property thisown

The membership flag

class StepData_EnumTool(*args)

Bases: object

• Creates an EnumTool with definitions given by e0 .. e<max> Each definition string can bring one term, or several separated by blanks. Each term corresponds to one value of the enumeration, if dots are not presents they are added //! Such a static constructor allows to build a static description asstatic StepData_EnumTool myenumtool(‘e0’,’e1’…); then use it without having to initialise it //! A null definition can be input by given ‘$’ :the corresponding position is attached to ‘null/undefined’ value (as one particular item of the enumeration list)

  param e0

  default value is

  type e0

  char *

  param e1

  default value is

  type e1

  char *

  param e2

  default value is

  type e2

  char *

  param e3

  default value is

  type e3

  char *

  param e4

  default value is

  type e4

  char *

  param e5

  default value is

  type e5

  char *

  param e6

  default value is

  type e6

  char *

  param e7

  default value is

  type e7

  char *

  param e8

  default value is

  type e8

  char *

  param e9

  default value is

  type e9

  char *

  param e10

  default value is

  type e10

  char *

  param e11

  default value is

  type e11

  char *

  param e12

  default value is

  type e12

  char *

  param e13

  default value is

  type e13

  char *

  param e14

  default value is

  type e14

  char *

  param e15

  default value is

  type e15

  char *

  param e16

  default value is

  type e16

  char *

  param e17

  default value is

  type e17

  char *

  param e18

  default value is

  type e18

  char *

  param e19

  default value is

  type e19

  char *

  param e20

  default value is

  type e20

  char *

  param e21

  default value is

  type e21

  char *

  param e22

  default value is

  type e22

  char *

  param e23

  default value is

  type e23

  char *

  param e24

  default value is

  type e24

  char *

  param e25

  default value is

  type e25

  char *

  param e26

  default value is

  type e26

  char *

  param e27

  default value is

  type e27

  char *

  param e28

  default value is

  type e28

  char *

  param e29

  default value is

  type e29

  char *

  param e30

  default value is

  type e30

  char *

  param e31

  default value is

  type e31

  char *

  param e32

  default value is

  type e32

  char *

  param e33

  default value is

  type e33

  char *

  param e34

  default value is

  type e34

  char *

  param e35

  default value is

  type e35

  char *

  param e36

  default value is

  type e36

  char *

  param e37

  default value is

  type e37

  char *

  param e38

  default value is

  type e38

  char *

  param e39

  default value is

  type e39

  char *

  rtype

  None

AddDefinition()

• Processes a definition, splits it according blanks if any empty definitions are ignored A null definition can be input by given ‘$’ :the corresponding position is attached to ‘null/undefined’ value (as one particular item of the enumeration list) See also IsSet

  param term

  type term

  char *

  rtype

  None

IsSet()

• Returns True if at least one definition has been entered after creation time (i.e. by AddDefinition only) //! This allows to build a static description by a first passstatic StepData_EnumTool myenumtool(‘e0’ …); … if (!myenumtool.IsSet()) { for further inits myenumtool.AddDefinition(‘e21’); … }

  rtype

  bool

MaxValue()

• Returns the maximum integer for a suitable value Remarkwhile values begin at zero, MaxValue is the count of recorded values minus one

  rtype

  int

NullValue()

• Returns the value attached to ‘null/undefined value’ If none is specified or if Optional has been set to False, returns -1 Null Value has been specified by definition ‘$’

  rtype

  int

Optional()

• Sets or Unsets the EnumTool to accept undefined value (for optional field). Ignored if no null value is defined (by ‘$’) Can be changed during execution (to read each field), Default is True (if a null value is defined)

  param mode

  type mode

  bool

  rtype

  None

Text()

• Returns the text which corresponds to a given numeric value It is limited by dots If num is out of range, returns an empty string

  param num

  type num

  int

  rtype

  TCollection_AsciiString

Value()

• Returns the numeric value found for a text The text must be in capitals and limited by dots A non-suitable text gives a negative value to be returned

  param txt

  type txt

  char *

  rtype

  int* Same as above but works on an AsciiString

  param txt

  type txt

  TCollection_AsciiString

  rtype

  int

property thisown

The membership flag

class StepData_Field(*args)

Bases: object

• Creates a Field, empty (‘no value defined’)

  rtype

  None* Creates a Field from another one. If <copy> is True, Handled data (Select,String,List, not entities) are copied

  param other

  type other

  StepData_Field

  param copy

  default value is Standard_False

  type copy

  bool

  rtype

  None

Arity()

Return type

int

Boolean()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: bool

Clear()

• Clears the field, to set it as ‘no value defined’ Just before SetList, predeclares it as ‘any’ A Kind can be directly set here to declare a type

  param kind

  default value is 0

  type kind

  int

  rtype

  None

ClearItem()

• Declares an item of the list as undefined (ignored if list not defined as String,Entity or Any)

  param num

  type num

  int

  rtype

  None

CopyFrom()

• Gets the copy of the values of another field

  param other

  type other

  StepData_Field

  rtype

  None

Entity()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: opencascade::handle<Standard_Transient>

Enum()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: int

EnumText()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: char *

Int()

Return type

int

Integer()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: int

IsSet()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: bool

ItemKind()

• Returns the kind of an item in a list or double list It is the kind of the list, except if it is ‘Any’, in such a case the true kind is determined and returned

  param n1

  default value is 1

  type n1

  int

  param n2

  default value is 1

  type n2

  int

  rtype

  int

Kind()

• Returns the kind of the field <type> True (D)returns only the type itself else, returns the complete kind

  param type

  default value is Standard_True

  type type

  bool

  rtype

  int

Length()

Parameters

index – default value is 1 :type index: int :rtype: int

Logical()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: StepData_Logical

Lower()

Parameters

index – default value is 1 :type index: int :rtype: int

Real()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: float

Set()

• Sets an undetermined valuecan be String, SelectMember, HArray(1-2) … else, an Entity In case of an HArray, determines and records its size(s)

  param val

  type val

  Standard_Transient

  rtype

  None

SetBoolean()

• Sets a Boolean value (or predeclares a list as boolean)

  param val

  default value is Standard_False

  type val

  bool

  rtype

  None:param num:

  type num

  int

  param val

  type val

  bool

  rtype

  None

SetDerived()

• Codes a Field as derived (no proper value)

  rtype

  None

SetEntity()

• Sets an Entity Value

  param val

  type val

  Standard_Transient

  rtype

  None* Predeclares a list as of entity

  rtype

  None:param num:

  type num

  int

  param val

  type val

  Standard_Transient

  rtype

  None

SetEnum()

• Sets an Enum Value (as its integer counterpart) (or predeclares a list as Enum) If <text> is given , also sets its textual expression <val> negative means unknown (known values begin at 0)

  param val

  default value is -1

  type val

  int

  param text

  default value is

  type text

  char *

  rtype

  None* Sets an Enum Value (Integer counterpart), also its text expression if known (if list has been set as ‘any’)

  param num

  type num

  int

  param val

  type val

  int

  param text

  default value is

  type text

  char *

  rtype

  None

SetInt()

• Directly sets the Integer value, if its Kind matches Integer, Boolean, Logical, or Enum (does not change Kind)

  param val

  type val

  int

  rtype

  None* Internal access to an Integer Value for a list, plus its kind

  param num

  type num

  int

  param val

  type val

  int

  param kind

  type kind

  int

  rtype

  None

SetInteger()

• Sets an Integer value (before SetList* declares it as Integer)

  param val

  default value is 0

  type val

  int

  rtype

  None* Sets an Integer Value for a list (rank num) (recognizes a SelectMember)

  param num

  type num

  int

  param val

  type val

  int

  rtype

  None

SetList()

• Declares a field as a list, with an initial size Initial lower is defaulted as 1, can be defined The list starts empty, typed by the last Set* If no Set* before, sets it as ‘any’ (transient/select)

  param size

  type size

  int

  param first

  default value is 1

  type first

  int

  rtype

  None

SetList2()

• Declares a field as an homogeneous square list, with initial sizes, and initial lowers

  param siz1

  type siz1

  int

  param siz2

  type siz2

  int

  param f1

  default value is 1

  type f1

  int

  param f2

  default value is 1

  type f2

  int

  rtype

  None

SetLogical()

• Sets a Logical Value (or predeclares a list as logical)

  param val

  default value is StepData_LFalse

  type val

  StepData_Logical

  rtype

  None:param num:

  type num

  int

  param val

  type val

  StepData_Logical

  rtype

  None

SetReal()

• Sets a Real Value (or predeclares a list as Real);

  param val

  default value is 0.0

  type val

  float

  rtype

  None:param num:

  type num

  int

  param val

  type val

  float

  rtype

  None

SetSelectMember()

• Sets a SelectMember (for Integer,Boolean,Enum,Real,Logical) Hence, the value of the field is accessed through this member

  param val

  type val

  StepData_SelectMember

  rtype

  None

SetString()

• Sets a String Value (or predeclares a list as String) Does not redefine the Kind if it is alread String or Enum

  param val

  default value is

  type val

  char *

  rtype

  None:param num:

  type num

  int

  param val

  type val

  char *

  rtype

  None

String()

Parameters

n1 – default value is 1 :type n1: int :param n2: default value is 1 :type n2: int :rtype: char *

Transient()

Return type

opencascade::handle<Standard_Transient>

property thisown

The membership flag

class StepData_FieldList(*args)

Bases: object

• Creates a FieldList of 0 Field

  rtype

  None

CField()

• Returns the field n0 <num> between 1 and NbFields, in order to modify its content

  param num

  type num

  int

  rtype

  StepData_Field

Field()

• Returns the field n0 <num> between 1 and NbFields (read only)

  param num

  type num

  int

  rtype

  StepData_Field

FillShared()

• Fills an iterator with the entities shared by <self>

  param iter

  type iter

  Interface_EntityIterator

  rtype

  None

NbFields()

• Returns the count of fields. Here, returns 0

  rtype

  int

property thisown

The membership flag

class StepData_FieldList1(*args)

Bases: OCC.Core.StepData.StepData_FieldList

• Creates a FieldList of 1 Field

  rtype

  None

property thisown

The membership flag

class StepData_FieldListD(*args)

Bases: OCC.Core.StepData.StepData_FieldList

• Creates a FieldListD of <nb> Fields

  param nb

  type nb

  int

  rtype

  None

SetNb()

• Sets a new count of Fields. Former contents are lost

  param nb

  type nb

  int

  rtype

  None

property thisown

The membership flag

class StepData_FieldListN(*args)

Bases: OCC.Core.StepData.StepData_FieldList

• Creates a FieldListN of <nb> Fields

  param nb

  type nb

  int

  rtype

  None

property thisown

The membership flag

class StepData_FileProtocol(*args)

Bases: OCC.Core.StepData.StepData_Protocol

• Creates an empty FileProtocol

  rtype

  None

Add()

• Adds a Protocol to the definition list of the FileProtocol But ensures that each class of Protocol is present only once in this list

  param protocol

  type protocol

  StepData_Protocol

  rtype

  None

static DownCast(t)

property thisown

The membership flag

class StepData_FileRecognizer(*args, **kwargs)

Bases: OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Add()

• Adds a new Recognizer to the Compound, at the end Several calls to Add work by adding in the order of callsHence, when Eval has failed to recognize, Evaluate will call Evaluate from the first added Recognizer if there is one, and to the second if there is still no result, and so on

  param reco

  type reco

  StepData_FileRecognizer

  rtype

  None

static DownCast(t)

Evaluate()

• Evaluates if recognition has a result, returns it if yes In case of success, Returns True and puts result in ‘res’ In case of Failure, simply Returns False Works by calling deferred method Eval, and in case of failure, looks for Added Recognizers to work

  param akey

  type akey

  TCollection_AsciiString

  param res

  type res

  Standard_Transient

  rtype

  bool

Result()

• Returns result of last recognition (call of Evaluate)

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class StepData_GeneralModule(*args, **kwargs)

Bases: OCC.Core.Interface.Interface_GeneralModule

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

static DownCast(t)

property thisown

The membership flag

class StepData_GlobalNodeOfWriterLib(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty GlobalNode, with no Next

  rtype

  None

Add()

• Adds a Module bound with a Protocol to the listdoes nothing if already in the list, THAT IS, Same Type (exact match) and Same State (that is, IsEqual is not required) Once added, stores its attached Protocol in correspondance

  param amodule

  type amodule

  StepData_ReadWriteModule

  param aprotocol

  type aprotocol

  StepData_Protocol

  rtype

  None

static DownCast(t)

Module()

• Returns the Module stored in a given GlobalNode

  rtype

  opencascade::handle<StepData_ReadWriteModule>

Next()

• Returns the Next GlobalNode. If none is defined, returned value is a Null Handle

  rtype

  opencascade::handle<StepData_GlobalNodeOfWriterLib>

Protocol()

• Returns the attached Protocol stored in a given GlobalNode

  rtype

  opencascade::handle<StepData_Protocol>

property thisown

The membership flag

class StepData_HArray1OfField(*args)

Bases: OCC.Core.StepData.StepData_Array1OfField, OCC.Core.Standard.Standard_Transient

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

Array1()

ChangeArray1()

static DownCast(t)

property thisown

The membership flag

class StepData_NodeOfWriterLib(*args)

Bases: OCC.Core.Standard.Standard_Transient

• Creates an empty Node, with no Next

  rtype

  None

AddNode()

• Adds a couple (Module,Protocol), that is, stores it into itself if not yet done, else creates a Next Node to do it

  param anode

  type anode

  StepData_GlobalNodeOfWriterLib

  rtype

  None

static DownCast(t)

Module()

• Returns the Module designated by a precise Node

  rtype

  opencascade::handle<StepData_ReadWriteModule>

Next()

• Returns the Next Node. If none was defined, returned value is a Null Handle

  rtype

  opencascade::handle<StepData_NodeOfWriterLib>

Protocol()

• Returns the Protocol designated by a precise Node

  rtype

  opencascade::handle<StepData_Protocol>

property thisown

The membership flag

class StepData_PDescr(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None

AddArity()

• Adds an arity count to <self>, by default 1 1a simple field passes to a LIST/ARRAY etc or a LIST to a LIST OF LIST 2a simple field passes to a LIST OF LIST

  param arity

  default value is 1

  type arity

  int

  rtype

  None

AddEnumDef()

• Adds an enum value as a string

  param enumdef

  type enumdef

  char *

  rtype

  None

AddMember()

• Adds a member to a SELECT description

  param member

  type member

  StepData_PDescr

  rtype

  None

Arity()

• Returns the arity of <self>

  rtype

  int

Check()

• Semantic Check of a Fielddoes it complies with the given description ?

  param afild

  type afild

  StepData_Field

  param ach

  type ach

  Interface_Check

  rtype

  void

DescrName()

• Returns the description (type name) to match, for a Described (else, empty string)

  rtype

  char *

static DownCast(t)

EnumMax()

• Returns the maximum integer for a suitable value (count - 1)

  rtype

  int

EnumText()

• Returns the text which corresponds to a numeric value, between 0 and EnumMax. It is limited by dots

  param val

  type val

  int

  rtype

  char *

EnumValue()

• Returns the numeric value found for an enum text The text must be in capitals and limited by dots A non-suitable text gives a negative value to be returned

  param name

  type name

  char *

  rtype

  int

FieldName()

Return type

char *

FieldRank()

Return type

int

IsBoolean()

• Tells if <self> is for a Boolean value (false,true)

  rtype

  bool

IsDerived()

• Tells if <self> is Derived

  rtype

  bool

IsDescr()

• Tells if <self> is for a Described entity of a given EDescr (does this EDescr match description name ?). For late-bnd (works for <self> + nexts if <self> is a Select)

  param descr

  type descr

  StepData_EDescr

  rtype

  bool

IsEntity()

• Tells if <self> is for an Entity, either Described or CDL Type

  rtype

  bool

IsEnum()

• Tells if <self> is for an Enum value Then, call AddEnumDef ordered from the first one (value 0) Managed by an EnumTool

  rtype

  bool

IsField()

• Tells if <self> is a Field. Else it is a Type

  rtype

  bool

IsInteger()

• Tells if <self> is for an Integer

  rtype

  bool

IsLogical()

• Tells if <self> is for a Logical value (false,true,unknown)

  rtype

  bool

IsOptional()

• Tells if <self> is Optional

  rtype

  bool

IsReal()

• Tells if <self> is for a Real value

  rtype

  bool

IsSelect()

• Tells if <self> is for a SELECT

  rtype

  bool

IsString()

• Tells if <self> is for a String value

  rtype

  bool

IsType()

• Tells if <self> is for an entity of a given CDL type (early-bnd) (works for <self> + nexts if <self> is a Select)

  param atype

  type atype

  Standard_Type

  rtype

  bool

Member()

• For a SELECT, returns the member whose name matches <name> To this member, the following question can then be asked Null Handle if <name> not matched or <self> not a SELECT //! Remarknot to be asked for an entity type Hence, following IsInteger .. Enum* only apply on <self> and require Member While IsType applies on <self> and all Select Members

  param name

  type name

  char *

  rtype

  opencascade::handle<StepData_PDescr>

Name()

Return type

char *

SetArity()

• Directly sets the arity count 0simple field 1LIST or ARRAY etc 2LIST OF LIST

  param arity

  default value is 1

  type arity

  int

  rtype

  None

SetBoolean()

• Sets <self> for a Boolean value (false,true)

  rtype

  None

SetDerived()

• Sets/Unsets <self> to be for a derived field

  param der

  default value is Standard_True

  type der

  bool

  rtype

  None

SetDescr()

• Sets <self> for a Described Entity, whose Description must match the type name <dscnam>

  param dscnam

  type dscnam

  char *

  rtype

  None

SetEnum()

• Sets <self> for an Enum value Then, call AddEnumDef ordered from the first one (value 0)

  rtype

  None

SetField()

• Sets <self> to describe a field of an entity With a name and a rank

  param name

  type name

  char *

  param rank

  type rank

  int

  rtype

  None

SetFrom()

• Sets <self> as <other> but duplicated Hence, some definition may be changed

  param other

  type other

  StepData_PDescr

  rtype

  None

SetInteger()

• Sets <self> for an Integer value

  rtype

  None

SetLogical()

• Sets <self> for a Logical value (false,true,unknown)

  rtype

  None

SetMemberName()

• Sets a name for SELECT member. To be used if a member is for an immediate type

  param memname

  type memname

  char *

  rtype

  None

SetName()

Parameters

name –

type name

char *

rtype

None

SetOptional()

• Sets/Unsets <self> to accept undefined values

  param opt

  default value is Standard_True

  type opt

  bool

  rtype

  None

SetReal()

• Sets <self> for a Real value

  rtype

  None

SetSelect()

• Declares this PDescr to be a Select, hence to have members <self> itself can be the first member

  rtype

  None

SetString()

• Sets <self> for a String value

  rtype

  None

SetType()

• Sets <self> for an Entity which must match a Type (early-bound)

  param atype

  type atype

  Standard_Type

  rtype

  None

Simple()

• For a LIST or LIST OF LIST, Returns the PDescr for the simpler PDescr. Else, returns <self> This allows to have different attributes for Optional for instance, on a field, and on the parameter of a LIST[OPTIONAL] LIST OF [OPTIONAL] …

  rtype

  opencascade::handle<StepData_PDescr>

Type()

• Returns the type to match (IsKind), for a CDL Entity (else, null handle)

  rtype

  opencascade::handle<Standard_Type>

property thisown

The membership flag

class StepData_Plex(*args)

Bases: OCC.Core.StepData.StepData_Described

• Creates a Plex (empty). The complete creation is made by the ECDescr itself, by calling Add

  param descr

  type descr

  StepData_ECDescr

  rtype

  None

Add()

• Adds a member to <self>

  param member

  type member

  StepData_Simple

  rtype

  None

static DownCast(t)

ECDescr()

• Returns the Description as for a Plex

  rtype

  opencascade::handle<StepData_ECDescr>

Member()

• Returns a simple member from its rank

  param num

  type num

  int

  rtype

  opencascade::handle<StepData_Simple>

NbMembers()

• Returns the count of simple members

  rtype

  int

TypeList()

• Returns the actual list of members types

  rtype

  opencascade::handle<TColStd_HSequenceOfAsciiString>

property thisown

The membership flag

class StepData_Protocol(*args)

Bases: OCC.Core.Interface.Interface_Protocol

Return type

None

AddBasicDescr()

• Records an ESDescr, intended to build complex descriptions

  param esdescr

  type esdescr

  StepData_ESDescr

  rtype

  None

AddDescr()

• Records an EDescr with its case number Also records its name for an ESDescr (simple type): an ESDescr is then used, for case number, or for type name

  param adescr

  type adescr

  StepData_EDescr

  param CN

  type CN

  int

  rtype

  None

AddPDescr()

• Records an PDescr

  param pdescr

  type pdescr

  StepData_PDescr

  rtype

  None

BasicDescr()

• Returns a basic description according to its name <anylevel> True (D)for <self> and its resources <anylevel> Falsefor <self> only

  param name

  type name

  char *

  param anylevel

  default value is Standard_True

  type anylevel

  bool

  rtype

  opencascade::handle<StepData_EDescr>

Descr()

• Returns the description attached to a case number, or null

  param num

  type num

  int

  rtype

  opencascade::handle<StepData_EDescr>* Returns a description according to its name <anylevel> True (D) : for <self> and its resources <anylevel> False : for <self> only

  param name

  type name

  char *

  param anylevel

  default value is Standard_True

  type anylevel

  bool

  rtype

  opencascade::handle<StepData_EDescr>

DescrNumber()

• Returns a unique positive CaseNumber for types described by an EDescr (late binding) WarningTypeNumber and DescrNumber must give together a unique positive case number for each distinct case, type or descr

  param adescr

  type adescr

  StepData_EDescr

  rtype

  int

static DownCast(t)

ECDescr()

• Returns a complex description according to list of names <anylevel> True (D)for <self> and its resources <anylevel> Falsefor <self> only

  param names

  type names

  TColStd_SequenceOfAsciiString

  param anylevel

  default value is Standard_True

  type anylevel

  bool

  rtype

  opencascade::handle<StepData_ECDescr>

ESDescr()

• Idem as Descr but cast to simple description

  param name

  type name

  char *

  param anylevel

  default value is Standard_True

  type anylevel

  bool

  rtype

  opencascade::handle<StepData_ESDescr>

HasDescr()

• Tells if a Protocol brings at least one ESDescr, i.e. if it defines at least one entity description by ESDescr mechanism

  rtype

  bool

PDescr()

• Returns a parameter description according to its name <anylevel> True (D)for <self> and its resources <anylevel> Falsefor <self> only

  param name

  type name

  char *

  param anylevel

  default value is Standard_True

  type anylevel

  bool

  rtype

  opencascade::handle<StepData_PDescr>

SchemaName()

• Returns the Schema Name attached to each class of Protocol To be redefined by each sub-class Here, SchemaName returns ‘(DEFAULT)’ was C++return const

  rtype

  char *

property thisown

The membership flag

class StepData_ReadWriteModule(*args, **kwargs)

Bases: OCC.Core.Interface.Interface_ReaderModule

• Empty constructor

Return type

None* Copy constructor – does nothing

Parameters

& (Standard_Transient) –

Return type

None

CaseStep()

• Defines Case Numbers corresponding to the recognized Types Called by CaseNum (data,num) above for a Simple Type Entity WarningCaseStep must give the same Value as Protocol does for the Entity type which corresponds to this Type given as a String

  param atype

  type atype

  TCollection_AsciiString

  rtype

  int* Same a above but for a Complex Type Entity (‘Plex’) The provided Default recognizes nothing

  param types

  type types

  TColStd_SequenceOfAsciiString

  rtype

  int

ComplexType()

• Function specific to STEP, which delivers the list of types which corresponds to a complex type. If <CN> is not for a complex type, this method returns False. Else it returns True and fills the list in alphabetic order. The default returns False. To be redefined as required.

  param CN

  type CN

  int

  param types

  type types

  TColStd_SequenceOfAsciiString

  rtype

  bool

static DownCast(t)

IsComplex()

• Returns True if the Case Number corresponds to a Complex Type (‘Plex’). Remember that all possible combinations must be aknowledged to be processed Default is False for all cases. For a Protocol which defines possible Plexes, this method must be redefined.

  param CN

  type CN

  int

  rtype

  bool

ReadStep()

• Specific Read Function. Works with StepReaderData

  param CN

  type CN

  int

  param data

  type data

  StepData_StepReaderData

  param num

  type num

  int

  param ach

  type ach

  Interface_Check

  param ent

  type ent

  Standard_Transient

  rtype

  void

ShortType()

• Function specific to STEP. Some STEP Types have a short form This method can be redefined to fill it By default, returns an empty string, which is then interpreted to take normal form from StepType

  param CN

  type CN

  int

  rtype

  TCollection_AsciiString

StepType()

• Function specific to STEP, which delivers the StepType as it is recorded in and read from a File compliant with STEP. This method is symmetric to the method CaseStep. StepType can be different from Dynamic Type’s name, but belongs to the same class of Object. Returns an empty String if <CN> is zero. WarningFor a Complex Type Entity, returns an Empty String (Complex Type must be managed by users)

  param CN

  type CN

  int

  rtype

  TCollection_AsciiString

WriteStep()

• Write Function, switched by CaseNum

  param CN

  type CN

  int

  param SW

  type SW

  StepData_StepWriter

  param ent

  type ent

  Standard_Transient

  rtype

  void

property thisown

The membership flag

class StepData_SelectArrReal(*args)

Bases: OCC.Core.StepData.StepData_SelectNamed

Return type

None

ArrReal()

Return type

opencascade::handle<TColStd_HArray1OfReal>

static DownCast(t)

SetArrReal()

Parameters

arr –

type arr

TColStd_HArray1OfReal

rtype

None

property thisown

The membership flag

class StepData_SelectInt(*args)

Bases: OCC.Core.StepData.StepData_SelectMember

Return type

None

static DownCast(t)

property thisown

The membership flag

class StepData_SelectMember(*args)

Bases: OCC.Core.Standard.Standard_Transient

Return type

None

Boolean()

Return type

bool

static DownCast(t)

Enum()

Return type

int

EnumText()

Return type

char *

HasName()

• Tells if a SelectMember has a name. Default is False

  rtype

  bool

Int()

• This internal method gives access to a value implemented by an Integer (to read it)

  rtype

  int

Integer()

• Gets the value as an Integer

  rtype

  int

Kind()

Return type

int

Logical()

Return type

StepData_Logical

Matches()

• Tells if the name of a SelectMember matches a given one By default, compares the strings, can be redefined (optimised)

  param name

  type name

  char *

  rtype

  bool

Name()

• Returns the name of a SelectMember. Default is empty

  rtype

  char *

ParamType()

• Returns the Kind of the SelectMember, under the form of an enum ParamType

  rtype

  Interface_ParamType

Real()

Return type

float

SetBoolean()

Parameters

val –

type val

bool

rtype

None

SetEnum()

Parameters

val –

type val

int

param text

default value is

type text

char *

rtype

None

SetEnumText()

Parameters

val –

type val

int

param text

type text

char *

rtype

void

SetInt()

• This internal method gives access to a value implemented by an Integer (to set it)

  param val

  type val

  int

  rtype

  void

SetInteger()

Parameters

val –

type val

int

rtype

None

SetKind()

Parameters

kind –

type kind

int

rtype

void

SetLogical()

Parameters

val –

type val

StepData_Logical

rtype

None

SetName()

• Sets the name of a SelectMember, returns True if done, False if no name is allowed Default does nothing and returns False

  param name

  type name

  char *

  rtype

  bool

SetReal()

Parameters

val –

type val

float

rtype

void

SetString()

Parameters

val –

type val

char *

rtype

void

String()

Return type

char *

property thisown

The membership flag

class StepData_SelectNamed(*args)

Bases: OCC.Core.StepData.StepData_SelectMember

Return type

None

CField()

Return type

StepData_Field

static DownCast(t)

Field()

Return type

StepData_Field

property thisown

The membership flag

class StepData_SelectReal(*args)

Bases: OCC.Core.StepData.StepData_SelectMember

Return type

None

static DownCast(t)

property thisown

The membership flag

class StepData_SelectType(*args, **kwargs)

Bases: object

Boolean()

Return type

bool

CaseMem()

• Recognize a SelectMember (kind, name). Returns a positive value which identifies the case in the List of immediate cases (distinct from the List of Entity Types). Zero if not recognizes Default returns 0, saying that no immediate value is allowed

  param ent

  type ent

  StepData_SelectMember

  rtype

  int

CaseMember()

• Returns the Type of the stored SelectMember, or zero if it is Null or Entity. Calls the method CaseMem on Value

  rtype

  int

CaseNum()

• Recognizes the Type of an Entity. Returns a positive Number which identifies the Type in the definition List of the SelectType. Returns Zero if its Type in not in this List.

  param ent

  type ent

  Standard_Transient

  rtype

  int

CaseNumber()

• Recognizes the Type of the stored Entity, or zero if it is Null or SelectMember. Calls the first method CaseNum on Value

  rtype

  int

Description()

• Returns the Description which corresponds to <self> Null if no specific description to give. This description is used to control reading an check validity. Default returns a Null Handle, i.e. undefined description It can suffice if CaseNum and CaseMem give enough control

  rtype

  opencascade::handle<StepData_PDescr>

Int()

• This internal method gives access to a value implemented by an Integer (to read it)

  rtype

  int

Integer()

• Gets the value as an Integer

  rtype

  int

IsNull()

• Returns True if there is no Stored Entity (i.e. it is Null)

  rtype

  bool

Logical()

Return type

StepData_Logical

Matches()

• Returns True if the Type of an Entity complies with the definition list of the SelectType. Also checks for a SelectMember Default Implementation looks for CaseNum or CaseMem positive

  param ent

  type ent

  Standard_Transient

  rtype

  bool

Member()

• Returns Value as a SelectMember. Null if not a SelectMember

  rtype

  opencascade::handle<StepData_SelectMember>

NewMember()

• Returns a preferred SelectMember. Default returns a Null By default, a SelectMember can be set according to data type and Nameit is a SelectNamed if Name is defined //! This method allows to define, for a specific SelectType, a specific SelectMember than SelectNamed. For instance for a Real plus a Name, a SelectReal plus a case number is a good solution, lighter than SelectNamed which is very multipurpose

  rtype

  opencascade::handle<StepData_SelectMember>

Nullify()

• Nullifies the Stored Entity

  rtype

  None

Real()

Return type

float

SelectName()

• Returns the type name of SelectMember. If no SelectMember or with no type name, returns an empty string To change it, pass through the SelectMember itself

  rtype

  char *

SetBoolean()

Parameters

val –

type val

bool

param name

default value is

type name

char *

rtype

None

SetInt()

• This internal method gives access to a value implemented by an Integer (to set it)a SelectMember MUST ALREADY BE THERE !

  param val

  type val

  int

  rtype

  None

SetInteger()

• Sets a new Integer value, with an optional type name WarningIf a SelectMember is already set, works on itvalue and name must then be accepted by this SelectMember

  param val

  type val

  int

  param name

  default value is

  type name

  char *

  rtype

  None

SetLogical()

Parameters

val –

type val

StepData_Logical

param name

default value is

type name

char *

rtype

None

SetReal()

Parameters

val –

type val

float

param name

default value is

type name

char *

rtype

None

SetValue()

• Stores an Entity. This allows to define a specific SelectType class with one read method per member Type, which returns the Value casted with the good Type.

  param ent

  type ent

  Standard_Transient

  rtype

  None

Type()

• Returns the Effective (Dynamic) Type of the Stored Entity If it is Null, returns TYPE(Transient)

  rtype

  opencascade::handle<Standard_Type>

Value()

• Returns the Stored Entity. Can be used to define specific read methods (see above)

  rtype

  opencascade::handle<Standard_Transient>

property thisown

The membership flag

class StepData_Simple(*args)

Bases: OCC.Core.StepData.StepData_Described

• Creates a Simple Entity

  param descr

  type descr

  StepData_ESDescr

  rtype

  None

CFieldNum()

• Returns a field from its rank, in order to modify it

  param num

  type num

  int

  rtype

  StepData_Field

CFields()

• Returns the entire field list, read or write

  rtype

  StepData_FieldListN

static DownCast(t)

ESDescr()

• Returns description, as for simple

  rtype

  opencascade::handle<StepData_ESDescr>

FieldNum()

• Returns a field from its rank, for read-only use

  param num

  type num

  int

  rtype

  StepData_Field

Fields()

• Returns the entire field list, read-only

  rtype

  StepData_FieldListN

NbFields()

• Returns the count of fields

  rtype

  int

StepType()

• Returns the recorded StepType (TypeName of its ESDescr)

  rtype

  char *

property thisown

The membership flag

class StepData_StepDumper(*args)

Bases: object

• Creates a StepDumper, able to work on a given StepModel (which defines the total scope for dumping entities) and a given Protocol from Step (which defines the authorized types to be dumped) <mode> commands what is to be displayed (number or label) 0 for number (and corresponding labels are displayed apart) 1 for label (and corresponding numbers are displayed apart) 2 for label without anymore

  param amodel

  type amodel

  StepData_StepModel

  param protocol

  type protocol

  StepData_Protocol

  param mode

  default value is 0

  type mode

  int

  rtype

  None

Dump()

• Dumps a Entity on an Messenger. Returns True if sucess, False, if the entity to dump has not been recognized by the Protocol. <level> can have one of these values- 0prints the TYPE only, as known in STEP Files (StepType) If <ent> has not been regognized by the Protocol, or if its type is Complex, the StepType is replaced by the display of the cdl type. Complex Type are well processed by level 1. - 1dumps the entity, completely (whatever it has simple or complex type) but alone. - 2dumps the entity completely, plus the item its refers to at first level (a header message designates the starting entity of the dump) <Lists Shared and Implied> - 3dumps the entity and its refered items at any levels //! For levels 1,2,3, the numbers displayed (form #nnn) are the numbers of the corresponding entities in the Model

  param S

  type S

  Message_Messenger

  param ent

  type ent

  Standard_Transient

  param level

  type level

  int

  rtype

  bool* Works as Dump with a Transient, but directly takes the entity designated by its number in the Model Returns False, also if <num> is out of range

  param S

  type S

  Message_Messenger

  param num

  type num

  int

  param level

  type level

  int

  rtype

  bool

StepWriter()

• Gives an access to the tool which is used to workthis allow to acts on some parametersFloating Format, Scopes …

  rtype

  StepData_StepWriter

property thisown

The membership flag

class StepData_StepModel(*args)

Bases: OCC.Core.Interface.Interface_InterfaceModel

• Creates an empty STEP model with an empty header.

  rtype

  None

AddHeaderEntity()

• Adds an Entity to the Header

  param ent

  type ent

  Standard_Transient

  rtype

  None

static DownCast(t)

Entity()

• returns entity given its rank. Same as InterfaceEntity, but with a shorter name

  param num

  type num

  int

  rtype

  opencascade::handle<Standard_Transient>

HasHeaderEntity()

• says if a Header entity has a specifed type

  param atype

  type atype

  Standard_Type

  rtype

  bool

Header()

• returns Header entities under the form of an iterator

  rtype

  Interface_EntityIterator

HeaderEntity()

• Returns Header entity with specified type, if there is

  param atype

  type atype

  Standard_Type

  rtype

  opencascade::handle<Standard_Transient>

IdentLabel()

• returns the label ident attached to an entity, 0 if not in me

  param ent

  type ent

  Standard_Transient

  rtype

  int

SetIdentLabel()

• Attaches an ident to an entity to produce a label (does nothing if <ent> is not in <self>)

  param ent

  type ent

  Standard_Transient

  param ident

  type ident

  int

  rtype

  None

property thisown

The membership flag

class StepData_StepReaderData(*args)

Bases: OCC.Core.Interface.Interface_FileReaderData

• creates StepReaderData correctly dimensionned (necessary at creation time, because it contains arrays) nbheader is nb of records for Header, nbtotal for Header+Data and nbpar gives the total count of parameters

  param nbheader

  type nbheader

  int

  param nbtotal

  type nbtotal

  int

  param nbpar

  type nbpar

  int

  rtype

  None

AddStepParam()

• Fills the fields of a parameter of a record. This is a variant of AddParam, Adapted to STEP (optimized for specific values)

  param num

  type num

  int

  param aval

  type aval

  char *

  param atype

  type atype

  Interface_ParamType

  param nument

  default value is 0

  type nument

  int

  rtype

  None

CType()

• Returns Record Type as a CString was C++return const

  param num

  type num

  int

  rtype

  char *

CheckDerived()

• Checks if parameter <nump> of record <num> is given as Derived If this Check is successful (i.e. Param = ‘*’), returns True Else, fills <ach> with a Message which contains <mess> and returns False. According to <errstat>, this message is Warning if errstat is False (Default), Fail if errstat is True

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param errstat

  default value is Standard_False

  type errstat

  bool

  rtype

  bool

CheckNbParams()

• Checks Count of Parameters of record <num> to equate <nbreq> If this Check is successful, returns True Else, fills <ach> with an Error Message then returns False <mess> is included in the Error message if given non empty

  param num

  type num

  int

  param nbreq

  type nbreq

  int

  param ach

  type ach

  Interface_Check

  param mess

  default value is

  type mess

  char *

  rtype

  bool

ComplexType()

• Returns the List of Types which correspond to a Complex Type Entity. If not Complex, there is just one Type in it For a SubList or a Scope mark, <types> remains empty

  param num

  type num

  int

  param types

  type types

  TColStd_SequenceOfAsciiString

  rtype

  None

static DownCast(t)

FailEnumValue()

• Fills a check with a fail message if enumeration value does match parameter definition Just a help to centralize message definitions

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  rtype

  None

FindNextHeaderRecord()

• determine first suitable record of Header works as FindNextRecord, but treats only Header records

  param num

  type num

  int

  rtype

  int

GlobalCheck()

• Returns the Global Check. It can record Fail messages about Undefined References (detected by SetEntityNumbers)

  rtype

  opencascade::handle<Interface_Check>

IsComplex()

• Returns True if <num> corresponds to a Complex Type Entity (as can be defined by ANDOR Express clause)

  param num

  type num

  int

  rtype

  bool

NamedForComplex()

• Determines the first component which brings a given name, for a Complex Type Entity <num0> is the very first record of this entity <num> is given the last NextNamedForComplex, starts at zero it is returned as the newly found number Hence, in the normal case, NextNamedForComplex starts by num0 if <num> is zero, else by NextForComplex(num) If the alphabetic order is not respected, it restarts from num0 and loops on NextForComplex until finding <name> In case of ‘non-alphabetic order’, <ach> is filled with a Warning for this name In case of ‘not-found at all’, <ach> is filled with a Fail, and <num> is returned as zero //! Returns True if alphabetic order, False else

  param name

  type name

  char *

  param num0

  type num0

  int

  param num

  type num

  int

  param ach

  type ach

  Interface_Check

  rtype

  bool* Determines the first component which brings a given name, or short name for a Complex Type Entity <num0> is the very first record of this entity <num> is given the last NextNamedForComplex, starts at zero it is returned as the newly found number Hence, in the normal case, NextNamedForComplex starts by num0 if <num> is zero, else by NextForComplex(num) If the alphabetic order is not respected, it restarts from num0 and loops on NextForComplex until finding <name> In case of ‘non-alphabetic order’, <ach> is filled with a Warning for this name In case of ‘not-found at all’, <ach> is filled with a Fail, and <num> is returned as zero //! Returns True if alphabetic order, False else

  param theName

  type theName

  char *

  param theShortName

  type theShortName

  char *

  param num0

  type num0

  int

  param num

  type num

  int

  param ach

  type ach

  Interface_Check

  rtype

  bool

NextForComplex()

• Returns the Next ‘Componant’ for a Complex Type Entity, of which <num> is already a Componant (the first one or a next one) Returns 0 for a Simple Type or for the last Componant

  param num

  type num

  int

  rtype

  int

PrepareHeader()

• Works as SetEntityNumbers but for Headermore simple because there are no Reference, only Sub-Lists

  rtype

  None

ReadAny()

• Reads parameter <nump> of record <num> into a Transient Value according to the type of the parameterNamed for Integer,Boolean,Logical,Enum,RealSelectNamed Immediate Integer,Boolean,Logical,Enum,RealSelectInt/Real TextHAsciiString Identthe referenced Entity Sub-List not processed, see ReadSub This value is controlled by a Parameter Descriptor (PDescr), which controls its allowed type and value <ach> is filled if the read parameter does not match its description (the select is nevertheless created if possible) //! Warningval is in out, hence it is possible to predefine a specific SelectMember then to fill it. If <val> is Null or if the result is not a SelectMember, val itself is returned a new ref For a Select with a Name, <val> must then be a SelectNamed

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param descr

  type descr

  StepData_PDescr

  param val

  type val

  Standard_Transient

  rtype

  bool

ReadBoolean()

• reads parameter <nump> of record <num> as a Boolean Return value and Check managed as by ReadReal (demands a Boolean enum, i.e. text ‘.T.’ for True or ‘.F.’ for False)

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param flag

  type flag

  bool

  rtype

  bool

ReadEnum()

• Reads parameter <nump> of record <num> as an Enumeration (text between dots) and converts it to an integer value, by an EnumTool. Returns True if OK, false ifthis parameter is not enumeration, or is not recognized by the EnumTool (with fail)

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param enumtool

  type enumtool

  StepData_EnumTool

  param val

  type val

  int

  rtype

  bool

ReadEnumParam()

Parameters

num –

type num

int

param nump

type nump

int

param mess

type mess

char *

param ach

type ach

Interface_Check

param text

type text

char *

rtype

bool

ReadField()

• reads parameter <nump> of record <num> into a Field, controlled by a Parameter Descriptor (PDescr), which controls its allowed type(s) and value <ach> is filled if the read parameter does not match its description (but the field is read anyway) If the description is not defined, no control is done Returns True when done

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param descr

  type descr

  StepData_PDescr

  param fild

  type fild

  StepData_Field

  rtype

  bool

ReadInteger()

• reads parameter <nump> of record <num> as a single Integer. Return value & Check managed as by ReadXY (demands an Integer)

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param val

  type val

  int

  rtype

  bool

ReadList()

• reads a list of fields controlled by an ESDescr

  param num

  type num

  int

  param ach

  type ach

  Interface_Check

  param descr

  type descr

  StepData_ESDescr

  param list

  type list

  StepData_FieldList

  rtype

  bool

ReadLogical()

• reads parameter <nump> of record <num> as a Logical Return value and Check managed as by ReadBoolean (demands a Logical enum, i.e. text ‘.T.’, ‘.F.’, or ‘.U.’)

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param flag

  type flag

  StepData_Logical

  rtype

  bool

ReadReal()

• reads parameter <nump> of record <num> as a single Real value. Return value and Check managed as by ReadXY (demands a Real)

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param val

  type val

  float

  rtype

  bool

ReadString()

• reads parameter <nump> of record <num> as a String (text between quotes, quotes are removed by the Read operation) Return value and Check managed as by ReadXY (demands a String)

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param val

  type val

  TCollection_HAsciiString

  rtype

  bool

ReadSub()

• reads the content of a sub-list into a transientSelectNamed, or HArray1 of Integer,Real,String,Transient … recursive call if list of list … If a sub-list has mixed types, an HArray1OfTransient is produced, it may contain SelectMember Intended to be called by ReadField The returned status isnegative if failed, 0 if empty. Else the kind to be recorded in the field

  param numsub

  type numsub

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param descr

  type descr

  StepData_PDescr

  param val

  type val

  Standard_Transient

  rtype

  int

ReadSubList()

• reads parameter <nump> of record <num> as a sub-list (may be typed, see ReadTypedParameter in this case) Returns True if OK. Else (not a LIST), returns false and feeds Check with appropriate check If <optional> is True and Param is not defined, returns True with <ach> not filled and <numsub> returned as 0 Works with SubListNumber with <aslast> false (no specific case for last parameter)

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param numsub

  type numsub

  int

  param optional

  default value is Standard_False

  type optional

  bool

  param lenmin

  default value is 0

  type lenmin

  int

  param lenmax

  default value is 0

  type lenmax

  int

  rtype

  bool

ReadTypedParam()

• Resolves a parameter which can be enclosed in a type def., as TYPE(val). The parameter must then be read normally according its type. Parameter to be resolved is <nump> of record <num> <mustbetyped> True demands a typed parameter <mustbetyped> False accepts a non-typed parameter as option mess and ach as usual <numr>,<numrp> are the resolved record and parameter numbers = num,nump if no type, else numrp=1 <typ> returns the recorded type, or empty string Remarka non-typed list is considered as ‘non-typed’

  param num

  type num

  int

  param nump

  type nump

  int

  param mustbetyped

  type mustbetyped

  bool

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param numr

  type numr

  int

  param numrp

  type numrp

  int

  param typ

  type typ

  TCollection_AsciiString

  rtype

  bool

ReadXY()

• reads parameter <nump> of record <num> as a sub-list of two Reals X,Y. Returns True if OK. Else, returns false and feeds Check with appropriate Fails (parameter not a sub-list, not two Reals in the sub-list) composed with ‘mess’ which gives the name of the parameter

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param X

  type X

  float

  param Y

  type Y

  float

  rtype

  bool

ReadXYZ()

• reads parameter <nump> of record <num> as a sub-list of three Reals X,Y,Z. Return value and Check managed as by ReadXY (demands a sub-list of three Reals)

  param num

  type num

  int

  param nump

  type nump

  int

  param mess

  type mess

  char *

  param ach

  type ach

  Interface_Check

  param X

  type X

  float

  param Y

  type Y

  float

  param Z

  type Z

  float

  rtype

  bool

RecordIdent()

• Returns record identifier (Positive number) If returned ident is not positiveSub-List or Scope mark

  param num

  type num

  int

  rtype

  int

RecordType()

• Returns Record Type

  param num

  type num

  int

  rtype

  TCollection_AsciiString

SetEntityNumbers()

• determines reference numbers in EntityNumber fields called by Prepare from StepReaderTool to prepare later using by a StepModel. This method is attached to StepReaderData because it needs a massive amount of data accesses to work //! If <withmap> is given False, the basic exploration algorithm is activated, otherwise a map is used as far as it is possible this option can be used only to test this algorithm

  param withmap

  default value is Standard_True

  type withmap

  bool

  rtype

  None

SetRecord()

• Fills the fields of a record

  param num

  type num

  int

  param ident

  type ident

  char *

  param type

  type type

  char *

  param nbpar

  type nbpar

  int

  rtype

  None

SubListNumber()

• Returns SubList numero designated by a parameter (nump) in a record (num), or zero if the parameter does not exist or is not a SubList address. Zero too If aslast is True and nump is not for the last parameter

  param num

  type num

  int

  param nump

  type nump

  int

  param aslast

  type aslast

  bool

  rtype

  int

property thisown

The membership flag

class StepData_StepReaderTool(*args)

Bases: OCC.Core.Interface.Interface_FileReaderTool

• creates StepReaderTool to work with a StepReaderData according to a Step Protocol. Defines the ReaderLib at this time

  param reader

  type reader

  StepData_StepReaderData

  param protocol

  type protocol

  StepData_Protocol

  rtype

  None

Prepare()

• Bounds empty entities to records, uses default Recognition provided by ReaderLib and ReaderModule. Also calls computation of references (SetEntityNumbers from StepReaderData) Works only on data entities (skips header) <optimize> given False allows to test some internal algorithms which are normally avoided (see also StepReaderData)

  param optimize

  default value is Standard_True

  type optimize

  bool

  rtype

  None* Bounds empty entities to records, works with a specific FileRecognizer, stored and later used in Recognize Works only on data entities (skips header) <optimize : same as above

  param reco

  type reco

  StepData_FileRecognizer

  param optimize

  default value is Standard_True

  type optimize

  bool

  rtype

  None

PrepareHeader()

• bounds empty entities and sub-lists to header records works like Prepare + SetEntityNumbers, but for header (N.B.: in Header, no Ident and no reference) FileRecognizer is to specify Entities which are allowed to be defined in the Header (not every type can be)

  param reco

  type reco

  StepData_FileRecognizer

  rtype

  None

property thisown

The membership flag

class StepData_StepWriter(*args)

Bases: object

• Creates an empty StepWriter from a StepModel. The StepModel provides the Number of Entities, as identifiers for File

  param amodel

  type amodel

  StepData_StepModel

  rtype

  None

AddParam()

• prepares adding a parameter (that is, adds ‘,’ except for first one); normally for internal use; can be used to send a totally empty parameter (with no litteral value)

  rtype

  None

CheckList()

• Returns the check-list, which has received possible checksfor unknown entities, badly loaded ones, null or unknown references

  rtype

  Interface_CheckIterator

CloseSub()

• closes a sublist by a ‘)’

  rtype

  None

Comment()

• sets a comment markif mode is True, begins Comment zone, if mode is False, ends Comment zone (if one is begun)

  param mode

  type mode

  bool

  rtype

  None

EndComplex()

• sends the end of a complex entitya simple closed bracket It must be called AFTER sending all the componants and BEFORE the final call to EndEntity

  rtype

  None

EndEntity()

• sends end of entity (closing bracket plus ‘;’) Error if count of opened-closed brackets is not null

  rtype

  None

EndFile()

• sets end of file; error is EndSec was not set

  rtype

  None

EndSec()

• sets end of section; to be done before passing to next one

  rtype

  None

FloatWriter()

• Returns the embedded FloatWriter, which controls sending Reals Use this method to access FloatWriter in order to consult or change its options (MainFormat, FormatForRange,ZeroSuppress), because it is returned as the address of its field

  rtype

  Interface_FloatWriter

GetLabelMode(StepData_StepWriter self) → Standard_Integer

GetTypeMode(StepData_StepWriter self) → Standard_Integer

Indent()

• asks that further indentations will begin at position of entity first opening bracket; else they begin at zero (def) for each sublist level, two more blancks are added at beginning (except for text continuation, which must begin at true zero)

  param onent

  type onent

  bool

  rtype

  None

IsInScope()

• Returns True if an Entity identified by its Number is in a Scope

  param num

  type num

  int

  rtype

  bool

JoinLast()

• joins current line to last one, only if new length is 72 max if newline is True, a new current line begins; else, current line is set to the last line (once joined) itself an can be completed

  param newline

  type newline

  bool

  rtype

  None

Line()

• Returns a Line given its rank in the File

  param num

  type num

  int

  rtype

  opencascade::handle<TCollection_HAsciiString>

NbLines()

• Returns count of Lines

  rtype

  int

NewLine()

• flushes current line; if empty, flushes it (defines a new empty line) if evenempty is True; else, skips it

  param evenempty

  type evenempty

  bool

  rtype

  None

OpenSub()

• open a sublist by a ‘(‘

  rtype

  None

OpenTypedSub()

• open a sublist with its type then a ‘(‘

  param subtype

  type subtype

  char *

  rtype

  None

PrintToString(StepData_StepWriter self) → std::string

Send()

• sends an integer parameter

  param val

  type val

  int

  rtype

  None* sends a real parameter (wroks with FloatWriter)

  param val

  type val

  float

  rtype

  None* sends a text given as string (it will be set between ‘…’)

  param val

  type val

  TCollection_AsciiString

  rtype

  None* sends a reference to an entity (its identifier with ‘#’) REMARK 1 : a Null <val> is interpreted as ‘Undefined’ REMARK 2 : for an HAsciiString which is not recorded in the Model, it is send as its String Content, between quotes

  param val

  type val

  Standard_Transient

  rtype

  None

SendArrReal()

• sends an array of real

  param anArr

  type anArr

  TColStd_HArray1OfReal

  rtype

  None

SendBoolean()

• sends a Boolean as .T. for True or .F. for False (it is an useful case of Enum, which is built-in)

  param val

  type val

  bool

  rtype

  None

SendComment()

• sends a comment. Error if we are not inside a comment zone

  param text

  type text

  TCollection_HAsciiString

  rtype

  None* same as above but accepts a CString (ex.: ‘…’ directly)

  param text

  type text

  char *

  rtype

  None

SendData()

• Begins data section; error if EndSec was not set

  rtype

  None

SendDerived()

• sends a ‘Derived’ parameter (by ‘*’). A Derived Parameter has been inherited from a Super-Type then redefined as being computed by a function. Hence its value in file is senseless.

  rtype

  None

SendEndscope()

• sets an end of Scope (on a separate line)

  rtype

  None

SendEntity()

• Send an Entity of the Data Section. If it corresponds to a Scope, also Sends the Scope informations and contained Items

  param nument

  type nument

  int

  param lib

  type lib

  StepData_WriterLib

  rtype

  None

SendEnum()

• sends an enum given by String (litteral expression) adds ‘.’ around it if not done Remarkval can be computed by class EnumTool from StepData: StepWriter.SendEnum (myenum.Text(enumval));

  param val

  type val

  TCollection_AsciiString

  rtype

  None* sends an enum given by String (litteral expression) adds ‘.’ around it if not done

  param val

  type val

  char *

  rtype

  None

SendField()

• Sends the content of a field, controlled by its descriptor If the descriptor is not defined, follows the description detained by the field itself

  param fild

  type fild

  StepData_Field

  param descr

  type descr

  StepData_PDescr

  rtype

  None

SendHeader()

• Begins model header

  rtype

  None

SendIdent()

• begins an entity with an ident plus ‘=’ (at beginning of line) entity ident is its Number given by the containing Model Warning<ident> must be, either Number or Label, according LabelMode

  param ident

  type ident

  int

  rtype

  None

SendList()

• Send the content of an entity as being a FieldList controlled by its descriptor. This includes start and end brackets but not the entity type

  param list

  type list

  StepData_FieldList

  param descr

  type descr

  StepData_ESDescr

  rtype

  None

SendLogical()

• sends a Logical as .T. or .F. or .U. according its Value (it is a standard case of Enum for Step, and is built-in)

  param val

  type val

  StepData_Logical

  rtype

  None

SendModel()

• Sends the complete Model, included HEADER and DATA Sections Works with a WriterLib defined through a Protocol If <headeronly> is given True, only the HEADER Section is sent (used to Dump the Header of a StepModel)

  param protocol

  type protocol

  StepData_Protocol

  param headeronly

  default value is Standard_False

  type headeronly

  bool

  rtype

  None

SendScope()

• sets a begin of Scope (ends this line)

  rtype

  None

SendSelect()

• Sends a SelectMember, which cab be named or not

  param sm

  type sm

  StepData_SelectMember

  param descr

  type descr

  StepData_PDescr

  rtype

  None

SendString()

• sends a string exactly as it is given

  param val

  type val

  TCollection_AsciiString

  rtype

  None* sends a string exactly as it is given

  param val

  type val

  char *

  rtype

  None

SendUndef()

• sends an undefined (optionnal absent) parameter (by ‘$’)

  rtype

  None

SetLabelMode(StepData_StepWriter self, Standard_Integer value)

SetScope()

• Declares the Entity Number <numscope> to correspond to a Scope which contains the Entity Number <numin>. Several calls to the same <numscope> add Entities in this Scope, in this order. Error if <numin> is already declared in the Scope Warningthe declaration of the Scopes is assumed to be consistent, i.e. <numin> is not referenced from outside this Scope (not checked here)

  param numscope

  type numscope

  int

  param numin

  type numin

  int

  rtype

  None

SetTypeMode(StepData_StepWriter self, Standard_Integer value)

StartComplex()

• sends the start of a complex entity, which is a simple open bracket (without increasing braket level) It must be called JUST AFTER SendEntity and BEFORE sending componants, each one begins by StartEntity

  rtype

  None

StartEntity()

• sets entity’s StepType, opens brakets, starts param no to 0 params are separated by comma Remarkfor a Multiple Type Entity (see Express ANDOR clause) StartComplex must be called before sending componants, then each ‘Componant’ must be send separately (one call to StartEntity for each one)the Type which preceeds is then automaticaly closed. Once all the componants have been sent, EndComplex must be called, then and only then EndEntity

  param atype

  type atype

  TCollection_AsciiString

  rtype

  None

property thisown

The membership flag

class StepData_WriterLib(*args)

Bases: object

• Creates a Library which complies with a Protocol, that isSame class (criterium IsInstance) This creation gets the Modules from the global set, those which are bound to the given Protocol and its Resources

  param aprotocol

  type aprotocol

  StepData_Protocol

  rtype

  None* Creates an empty Library : it will later by filled by method AddProtocol

  rtype

  None

AddProtocol()

• Adds a couple (Module-Protocol) to the Library, given the class of a Protocol. Takes Resources into account. (if <aprotocol> is not of type TheProtocol, it is not added)

  param aprotocol

  type aprotocol

  Standard_Transient

  rtype

  None

Clear()

• Clears the list of Modules of a library (can be used to redefine the order of Modules before actionClear then refill the Library by calls to AddProtocol)

  rtype

  None

Module()

• Returns the current Module in the Iteration

  rtype

  opencascade::handle<StepData_ReadWriteModule>

More()

• Returns True if there are more Modules to iterate on

  rtype

  bool

Next()

• Iterates by getting the next Module in the list If there is none, the exception will be raised by Value

  rtype

  None

Protocol()

• Returns the current Protocol in the Iteration

  rtype

  opencascade::handle<StepData_Protocol>

Select()

• Selects a Module from the Library, given an Object. Returns True if Select has succeeded, False else. Also Returns (as arguments) the selected Module and the Case Number determined by the associated Protocol. If Select has failed, <module> is Null Handle and CN is zero. (Select can work on any criterium, such as Object DynamicType)

  param obj

  type obj

  Standard_Transient

  param module

  type module

  StepData_ReadWriteModule

  param CN

  type CN

  int

  rtype

  bool

SetComplete()

• Sets a library to be defined with the complete Global list (all the couples Protocol/Modules recorded in it)

  rtype

  None

static SetGlobal()

• Adds a couple (Module-Protocol) into the global definition set for this class of Library.

  param amodule

  type amodule

  StepData_ReadWriteModule

  param aprotocol

  type aprotocol

  StepData_Protocol

  rtype

  void

Start()

• Starts Iteration on the Modules (sets it on the first one)

  rtype

  None

property thisown

The membership flag

class SwigPyIterator(*args, **kwargs)

Bases: object

advance()

copy()

decr()

distance()

equal()

incr()

next()

previous()

property thisown

The membership flag

value()

class stepdata

Bases: object

static AddHeaderProtocol()

• Adds a new Header Protocol to the Header Definition

  param headerproto

  type headerproto

  StepData_Protocol

  rtype

  void

static HeaderProtocol()

• Returns the recorded HeaderProtocol, which can be- a Null Handle if no Header Protocol was yet defined - a simple Protocol if only one was defined - a FileProtocol if more than one Protocol was yet defined

  rtype

  opencascade::handle<StepData_Protocol>

static Init()

• Prepares General Data required to work with this package, which are the Protocol and Modules to be loaded into Libraries

  rtype

  void

static Protocol()

• Returns a Protocol from StepData (avoids to create it)

  rtype

  opencascade::handle<StepData_Protocol>

property thisown

The membership flag