StepData

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

Adds a new Header Protocol to the Header Definition.

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

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

Returns the Description used to define this entity.

Tells if a described entity is complex.

Tells if a step type is matched by <me> For a Simple Entity : own type or super type For a Complex Entity : one of the members.

Returns a Simple Entity which matches with a Type in <me> : For a Simple Entity : me if it matches, else a null handle For a Complex Entity : the member which matches, else null.

Tells if a Field brings a given name.

Returns a Field from its name; read-only.

Returns a Field from its name; read or write.

Fills a Check by using its Description.

Creates an ECDescr, empty.

Adds a member Warning : members are added in alphabetic order.

Returns the count of members.

Returns a Member from its rank.

Returns the ordered list of types.

Tells if a ESDescr matches a step type : exact or super type.

Returns True.

Creates a described entity (i.e. a complex one, made of one simple entity per member).

Tells if a ESDescr matches a step type : exact or super type.

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

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

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 as : static 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)

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.

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 pass : static StepData_EnumTool myenumtool("e0" ...); ... if (!myenumtool.IsSet()) { for further inits myenumtool.AddDefinition("e21"); ... }

Returns the maximum integer for a suitable value Remark : while values begin at zero, MaxValue is the count of recorded values minus one.

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).

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 "$".

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.

Creates an ESDescr with a type name.

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

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

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.

Sets an ESDescr as "super-type". Applies an a base (non derived) ESDescr.

Returns the type name given at creation time.

Returns the type name as an AsciiString.

Returns the basic ESDescr, null if <me> is not derived.

Returns the super-type ESDescr, null if <me> is root.

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

Returns the count of fields.

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

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

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

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

Tells if a ESDescr matches a step type : exact or super type.

Returns False.

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

Constructor.

Initializes the 3 factors for the conversion of units.

Sets length unit for current transfer process.

Returns length unit for current transfer process (mm by default).

Returns transient length factor for scaling of shapes at one stage of transfer process.

Returns transient plane angle factor for conversion of angles at one stage of transfer process.

Returns transient solid angle factor for conversion of angles at one stage of transfer process.

Returns transient factor radian degree for conversion of angles at one stage of transfer process.

Returns transient factor degree radian for conversion of angles at one stage of transfer process.

Gets the copy of the values of another field.

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.

Codes a Field as derived (no proper value).

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

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).

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

Sets an undetermined value : can be String, SelectMember, HArray(1-2) ... else, an Entity In case of an HArray, determines and records its size(s).

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

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.

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

Creates a FieldList of 0 Field.

Returns the count of fields. Here, returns 0.

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

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

Creates a FieldList of 1 Field.

Returns the count of fields. Here, returns 1.

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

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

Creates a FieldListD of <nb> Fields.

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

Returns the count of fields. Here, returns starting <nb>.

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

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

Creates a FieldListN of <nb> Fields.

Returns the count of fields. Here, returns starting <nb>.

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

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

Creates an empty FileProtocol.

Gives the count of Protocols used as Resource (can be zero) i.e. the count of Protocol recorded by calling the method Add.

Returns a Resource, given a rank. Here, rank of calling Add.

Returns a Case Number, specific of each recognized Type Here, NO Type at all is recognized properly : all Types are recognized by the resources.

Returns the Schema Name attached to each class of Protocol To be redefined by each sub-class Here, SchemaName returns "" (empty String) was C++ : return const.

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.

Returns result of last recognition (call of Evaluate).

Adds a new Recognizer to the Compound, at the end Several calls to Add work by adding in the order of calls : Hence, 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.

Creates an empty GlobalNode, with no Next.

Adds a Module bound with a Protocol to the list : does 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 correspondence.

Returns the Module stored in a given GlobalNode.

Returns the attached Protocol stored in a given GlobalNode.

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

Creates an empty Node, with no Next.

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

Returns the Module designated by a precise Node.

Returns the Protocol designated by a precise Node.

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

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

Adds a member to a SELECT description.

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

Sets <me> for an Integer value.

Sets <me> for a Real value.

Sets <me> for a String value.

Sets <me> for a Boolean value (false,true).

Sets <me> for a Logical value (false,true,unknown).

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

Adds an enum value as a string.

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

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

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

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

Sets <me> as <other> but duplicated Hence, some definition may be changed.

Sets/Unsets <me> to accept undefined values.

Sets/Unsets <me> to be for a derived field.

Sets <me> to describe a field of an entity With a name and a rank.

Tells if <me> is for a SELECT.

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 <me> not a SELECT.
Remark : not to be asked for an entity type Hence, following IsInteger .. Enum* only apply on <me> and require Member While IsType applies on <me> and all Select Members

Tells if <me> is for an Integer.

Tells if <me> is for a Real value.

Tells if <me> is for a String value.

Tells if <me> is for a Boolean value (false,true).

Tells if <me> is for a Logical value (false,true,unknown).

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

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

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.

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

Tells if <me> is for an Entity, either Described or CDL Type.

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

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

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

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

Returns the arity of <me>.

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

Tells if <me> is Optional.

Tells if <me> is Derived.

Tells if <me> is a Field. Else it is a Type.

Semantic Check of a Field : does it complies with the given description ?

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

Adds a member to <me>.

Returns the Description as for a Plex.

Returns False.

Tells if a step type is matched by <me> For a Simple Entity : own type or super type For a Complex Entity : one of the members.

Returns a Simple Entity which matches with a Type in <me> : For a Simple Entity : me if it matches, else a null handle For a Complex Entity : the member which matches, else null.

Tells if a Field brings a given name.

Returns a Field from its name; read-only.

Returns a Field from its name; read or write.

Returns the count of simple members.

Returns a simple member from its rank.

Returns the actual list of members types.

Fills a Check by using its Description.

Gives the count of Protocols used as Resource (can be zero) Here, No resource.

Returns a Resource, given a rank. Here, none.

Returns a unique positive number for any recognized entity Redefined to work by calling both TypeNumber and, for a Described Entity (late binding) DescrNumber.

Returns a Case Number, specific of each recognized Type Here, only Unknown Entity is recognized.

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.

Creates an empty Model for Step Norm.

Returns True if <model> is a Model of Step Norm.

Creates a new Unknown Entity for Step (UndefinedEntity).

Returns True if <ent> is an Unknown Entity for the Norm, i.e. Type UndefinedEntity, status Unknown.

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

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.

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

Idem as Descr but cast to simple description.

Returns a complex description according to list of names <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only.

Records an PDescr.

Returns a parameter description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only.

Records an ESDescr, intended to build complex descriptions.

Returns a basic description according to its name <anylevel> True (D) : for <me> and its resources <anylevel> False : for <me> only.

Same a above but for a Complex Type Entity ("Plex") The provided Default recognizes nothing.

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

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. Warning : For a Complex Type Entity, returns an Empty String (Complex Type must be managed by users).

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.

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.

Write Function, switched by CaseNum.

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

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

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

Returns the name of a SelectMember. Default is empty.

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

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

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

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

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

Gets the value as an Integer.

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

Returns the name of a SelectMember. Default is empty.

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

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

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

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.