Interface

Reservates for a count of more flags.

Sets for a new count of items, which can be either less or greater than the former one For new items, their flags start at false.

Adds a flag, a name can be attached to it Returns its flag number Makes required reservation.

Adds several flags (<more>) with no name Returns the number of last added flag.

Removes a flag given its number. Returns True if done, false if num is out of range.

Sets a name for a flag, given its number name can be empty (to erase the name of a flag) Returns True if done, false if : num is out of range, or name non-empty already set to another flag.

Returns the count of flags (flag 0 not included).

Returns the count of items (i.e. the length of the bitmap).

Returns the name recorded for a flag, or an empty string.

Returns the number or a flag given its name, or zero.

Returns the value (true/false) of a flag, from :

• the number of the item
• the flag number, by default 0

Sets a new value for a flag.

Sets a flag to True.

Sets a flag to False.

Returns the former value for a flag and sets it to True (before : value returned; after : True).

Returns the former value for a flag and sets it to False (before : value returned; after : False).

Initialises all the values of Flag Number <flag> to a given value <val>.

Clear all field of bit map.

Records a new Category defined by its names, produces a number New if not yet recorded.

Returns the count of recorded categories.

Returns the name of a category, according to its number.

Returns the number of a category, according to its name.

Default initialisation (protected against several calls : passes only once).

Sets/Changes Protocol.

Determines the Category Number for an entity in its context, by using general service CategoryNumber.

Clears the recorded list of category numbers for a Model.

Computes the Category Number for each entity and records it, in an array (ent.number -> category number) Hence, it can be queried by the method Num. The Model itself is not recorded, this method is intended to be used in a wider context (which detains also a Graph, etc).

Returns the category number recorded for an entity number Returns 0 if out of range.

New name for AddFail (Msg).

Returns True if Check brings at least one Fail Message.

Returns count of recorded Fails.

Returns Fail Message as a String Final form by default, Original form if <final> is False.

Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False.

Returns the list of Fails, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty.

New name for AddWarning.

Returns True if Check brings at least one Warning Message.

Returns count of recorded Warning messages.

Returns Warning message as a String Final form by default, Original form if <final> is False.

Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False.

Returns the list of Warnings, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty.

Records an information message This does not change the status of the Check.

Returns the count of recorded information messages.

Returns information message as a String.

Same as above, but returns a CString (to be printed ...) Final form by default, Original form if <final> is False.

Returns the list of Info Msg, for a frontal-engine logic Final forms by default, Original forms if <final> is False Can be empty.

Returns the Check Status : OK, Warning or Fail.

Returns True if a Check is devoted to an entity; else, it is global (for InterfaceModel's storing of global error messages).

Returns the entity on which the Check has been defined.

Clears a check, in order to receive information from transfer (Messages and Entity).

Clears the Fail Messages (for instance to keep only Warnings).

Clears the Warning Messages (for instance to keep only Fails).

Clears the Info Messages.

Removes the messages which comply with <mess>, as follows : <incl> = 0 : <mess> exactly matches one of the messages <incl> < 0 : <mess> is contained by one of the messages <incl> > 0 : <mess> contains one of the messages For <status> : for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (nothing is done) Returns True if at least one message has been removed, False else.

Mends messages, according <pref> and <num> According to <num>, works on the whole list of Fails if = 0(D) or only one Fail message, given its rank If <pref> is empty, converts Fail(s) to Warning(s) Else, does the conversion but prefixes the new Warning(s) but <pref> followed by a semi-column Some reserved values of <pref> are : "FM" : standard prefix "Mended" (can be translated) "CF" : clears Fail(s) "CW" : clears Warning(s) : here, <num> refers to Warning list "CA" : clears all messages : here, <num> is ignored.

Receives an entity result of a Transfer.

same as SetEntity (old form kept for compatibility) Warning : Does nothing if Entity field is not yet clear

Copies messages stored in another Check, cumulating Does not regard other's Entity. Used to cumulate messages.

Copies messages converted into Warning messages If failsonly is true, only Fails are taken, and converted else, Warnings are taken too. Does not regard Entity Used to keep Fail messages as Warning, after a recovery.

Prints the messages of the check to the default trace file By default, according to the default standard level Else, according level (see method Print).

Sets / Changes the name.

Returns the recorded name (can be empty).

Defines a Model, used to locate entities (not required, if it is absent, entities are simply less documented).

Returns the stored model (can be a null handle).

Clears the list of checks.

Adds a Check to the list to be iterated This Check is Accompanied by Entity Number in the Model (0 for Global Check or Entity unknown in the Model), if 0 and Model is recorded in <me>, it is computed.

Returns True if : no Fail has been recorded if <failsonly> is True, no Check at all if <failsonly> is False.

Returns worst status among : OK, Warning, Fail.

Tells if this check list complies with a given status : OK (i.e. empty), Warning (at least one Warning, but no Fail), Fail (at least one), Message (not OK), NoFail, Any.

Removes the messages of all Checks, under these conditions : <incl> = 0 : <mess> exactly matches one of the messages <incl> < 0 : <mess> is contained by one of the messages <incl> > 0 : <mess> contains one of the messages For <status> : for CheckWarning and CheckFail, considers only resp. Warning or Check messages. for CheckAny, considers all other values are ignored (nothing is done) Returns True if at least one message has been removed, False else.

Returns the list of entities concerned by a Check Only fails if <failsonly> is True, else all non-empty checks If <global> is true, adds the model for a global check Else, global check is ignored.

Starts Iteration. Thus, it is possible to restart it Remark : an iteration may be done with a const Iterator While its content is modified (through a pointer), this allows to give it as a const argument to a function.

Returns True if there are more Checks to get.

Sets Iteration to next Item.

Returns Check currently Iterated It brings all other information (status, messages, ...) The Number of the Entity in the Model is given by Number below.

Returns Number of Entity for the Check currently iterated or 0 for GlobalCheck.

Clears data of iteration.

Returns the Check associated to an Entity identified by its Number in a Model.

Checks if any Error has been detected (CheckList not empty) Returns normally if none, raises exception if some exists. It reuses the last computations from other checking methods, unless the argument <reset> is given True.

Clears List of Copy Results. Gets Ready to begin another Copy Process.

Bind a Result to a Starting Entity identified by its Number.

Searches for the Result bound to a Startingf Entity identified by its Number. If Found, returns True and fills <res> Else, returns False and nullifies <res>.

Creates a CopyMap adapted to work from a Model.

Clears Transfer List. Gets Ready to begin another Transfer.

Returns the InterfaceModel used at Creation time.

Binds a Starting Entity identified by its Number <num> in the Starting Model, to a Result of Transfer <res>.

Search for the result of a Starting Object (i.e. an Entity, identified by its Number <num> in the Starting Model) Returns True if a Result is Bound (and fills <res>) Returns False if no result is Bound (and nullifies <res>).

Returns the Model on which the CopyTool works.

Changes the Map of Result for another one. This allows to work with a more sophisticated Mapping Control than the Standard one which is CopyMap (e.g. TransferProcess from Transfer).

Returns the object used for Control.

Clears Transfer List. Gets Ready to begin another Transfer.

Creates the CounterPart of an Entity (by ShallowCopy), Binds it, then Copies the content of the former Entity to the other one (same Type), by call to the General Service Library It may command the Copy of Referenced Entities Then, its returns True.
If <mapped> is True, the Map is used to store the Result Else, the Result is simply produced : it can be used to Copy internal sub-parts of Entities, which are not intended to be shared (Strings, Arrays, etc...) If <errstat> is True, this means that the Entity is recorded in the Model as Erroneous : in this case, the General Service for Deep Copy is not called (this could be dangerous) : hence the Counter-Part is produced but empty, it can be referenced.
This method does nothing and returns False if the Protocol does not recognize <ent>. It basically makes a Deep Copy without changing the Types. It can be redefined for special uses.

Transfers one Entity, if not yet bound to a result Remark : For an Entity which is reported in the Starting Model, the ReportEntity will also be copied with its Content if it has one (at least ShallowCopy; Complete Copy if the Protocol recognizes the Content : see method Copy).

Defines a Result for the Transfer of a Starting object. Used by method Transferred (which performs a normal Copy), but can also be called to enforce a result : in the latter case, the enforced result must be compatible with the other Transfers which are performed.

Search for the result of a Starting Object (i.e. an Entity) Returns True if a Result is Bound (and fills "result") Returns False if no result is Bound.

Clears LastFlags only. This allows to know what Entities are copied after its call (see method LastCopiedAfter). It can be used when copies are done by increments, which must be distinguished. ClearLastFlags is also called by Clear.

Returns an copied Entity and its Result which were operated after last call to ClearLastFlags. It returns the first "Last Copied Entity" which Number follows <numfrom>, Zero if none. It is used in a loop as follow : Integer num = 0; while ( (num = CopyTool.LastCopiedAfter(num,ent,res)) ) { .. Process Starting <ent> and its Result <res> }.

Transfers one Entity and records result into the Transfer List Calls method Transferred.

Renews the Implied References. These References do not involve Copying of referenced Entities. For such a Reference, if the Entity which defines it AND the referenced Entity are both copied, then this Reference is renewed. Else it is deleted in the copied Entities. Remark : this concerns only some specific references, such as "back pointers".

Fills a Model with the result of the transfer (TransferList) Commands copy of Header too, and calls RenewImpliedRefs.

Appends an Entity to the Cluster. If it is not full, adds the entity directly inside itself. Else, transmits to its Next and Creates it if it does not yet exist.

Returns total count of Entities (including Next).

Returns the Entity identified by its rank in the list (including Next).

Changes an Entity given its rank.

Gets a list of entities and adds its to the iteration list.

Adds to the iteration list a defined entity.

same as AddItem (kept for compatibility)

Selects entities with are Kind of a given type, keep only them (is keep is True) or reject only them (if keep is False).

Returns count of entities which will be iterated on Calls Start if not yet done.

Returns count of entities of a given type (kind of).

Allows re-iteration (useless for the first iteration).

Says if there are other entities (vertices) to iterate the first time, calls Start.

Sets iteration to the next entity (vertex) to give.

Returns the current Entity iterated, to be used by Interface tools.

Returns the content of the Iterator, accessed through a Handle to be used by a frontal-engine logic Returns an empty Sequence if the Iterator is empty Calls Start if not yet done.

Clears data of iteration.

Creates a List as being empty.

Clears the List.

Appends an Entity, that is to the END of the list (keeps order, but works slowerly than Add, see below).

Adds an Entity to the list, that is, with NO REGARD about the order (faster than Append if count becomes greater than 10).

Returns True if the list is empty.

Returns count of recorded Entities.

Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append).

Returns an Item given its number. Beware about the way the list was filled (see above, Add and Append).

Returns count of Entities of a given Type (0 : none).

Returns the Entity which is of a given type. If num = 0 (D), there must be ONE AND ONLY ONE If num > 0, returns the num-th entity of this type.

Same as above, but as a CString (for immediate exploitation) was C++ : return const.

Returns the type of the parameter.

Allows to set a reference to an Entity in a numbered list.

Returns value set by SetEntityNumber.

Clears stored data : frees memory taken for the String Value.

Destructor. Does nothing because Memory is managed by ParamSet.

Stores a Model. Used when the Model has been loaded.

Returns the stored Model.

Sets trace level used for outputting messages.

• 0: no trace at all
• 1: errors
• 2: errors and warnings
• 3: all messages Default is 1 : Errors traced

Returns trace level used for outputting messages.

Allows controlling whether exception raisings are handled If err is False, they are not (hence, dbx can take control) If err is True, they are, and they are traced (by putting on messenger Entity's Number and file record num) Default given at Model's creation time is True.

Returns ErrorHandle flag.

Fills records with empty entities; once done, each entity can ask the FileReaderTool for any entity referenced through an identifier. Calls Recognize which is specific to each specific type of FileReaderTool.

Recognizes a record, given its number. Specific to each Interface; called by SetEntities. It can call the basic method RecognizeByLib. Returns False if recognition has failed, True else. <ach> has not to be filled if simply Recognition has failed : it must record true error messages : RecognizeByLib can generate error messages if NewRead is called.
Note that it works thru a Recognizer (method Evaluate) which has to be memorized before starting

Recognizes a record with the help of Libraries. Can be used to implement the method Recognize. <rlib> is used to find Protocol and CaseNumber to apply <glib> performs the creation (by service NewVoid, or NewRead if NewVoid gave no result) <ach> is a check, which is transmitted to NewRead if it is called, gives a result but which is false <ent> is the result Returns False if recognition has failed, True else.

Provides an unknown entity, specific to the Interface called by SetEntities when Recognize has failed (Unknown alone) or by LoadModel when an Entity has caused a Fail on reading (to keep at least its literal description) Uses Protocol to do it.

Creates an empty Model of the norm. Uses Protocol to do it.

Reads and fills Entities from the FileReaderData set by SetData to an InterfaceModel. It enchains required operations, the specific ones correspond to deferred methods (below) to be defined for each Norm. It manages also error recovery and trace. Remark : it calls SetModel. It Can raise any error which can occur during a load operation, unless Error Handling is set. This method can also be redefined if judged necessary.

Reads, Fills and Returns one Entity read from a Record of the FileReaderData. This Method manages also case of Fail or Warning, by producing a ReportEntyty plus , for a Fail, a literal Content (as an UnknownEntity). Performs also Trace.

Fills model's header; each Interface defines for its Model its own file header; this method fills it from FileReaderTool.+ It is called by AnalyseFile from InterfaceModel.

Fills an Entity, given record no; specific to each Interface, called by AnalyseFile from InterfaceModel (which manages its calling arguments) To work, each Interface can define a method in its proper Transient class, like this (given as an example) : AnalyseRecord (me : mutable; FR : in out FileReaderTool; num : Integer; acheck : in out Check) returns Boolean; and call it from AnalyseRecord.
Returned Value : True if the entity could be loaded, False else (in case of syntactic fail)

Ends file reading after reading all the entities default is doing nothing; redefinable as necessary.

Clear fields.

Creates a FloatWriter ready to work, with default options.

• zero suppress option is set
• main format is set to "%E"
• secondary format is set to "%f" for values between 0.1 and

1. in absolute values If <chars> is given (and positive), it will produce options to produce this count of characters : "%<chars>f","%<chars>%E"

This class method converts a Real Value to a string, given options given as arguments. It can be called independently. Warning : even if declared in, content of <text> will be modified.

Sets a specific Format for Sending Reals (main format) (Default from Creation is "%E") If <reset> is given True (default), this call clears effects of former calls to SetFormatForRange and SetZeroSuppress.

Sets a secondary Format for Real, to be applied between R1 and R2 (in absolute values). A Call to SetRealForm cancels this secondary form if <reset> is True. (Default from Creation is "%f" between 0.1 and 1000.) Warning : if the condition (0. <= R1 < R2) is not fulfilled, this secondary form is canceled.

Sets Sending Real Parameters to suppress trailing Zeros and Null Exponent ("E+00"), if <mode> is given True, Resets this mode if <mode> is False (in addition to Real Forms) A call to SetRealFrom resets this mode to False ig <reset> is given True (Default from Creation is True).

Sets again options to the defaults given by Create.

Returns active options : <zerosup> is the option ZeroSuppress, <range> is True if a range is set, False else R1,R2 give the range (if it is set).

Returns the main format was C++ : return const.

Returns the format for range, if set Meaningful only if <range> from Options is True was C++ : return const.

Writes a Real value <val> to a string <text> by using the options. Returns the useful Length of produced string. It calls the class method Convert. Warning : <text> is assumed to be wide enough (20-30 is correct) And, even if declared in, its content will be modified.

Clears the list of Modules of a library (can be used to redefine the order of Modules before action : Clear then refill the Library by calls to AddProtocol).

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

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

Returns True if there are more Modules to iterate on.

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

Returns the current Protocol in the Iteration.

Creates an empty GlobalNode, with no Next.

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

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 GraphContent, ready to be filled.

Evaluates list of Entities to be iterated. Called by Start Default is set to doing nothing : intended to be redefined by each sub-class.

Returns the SignType. Can be null.

Returns the Signature for a Transient Object in a Model It calls SignType to do that If SignType is not defined, return ClassName of <ent>.

Returns the Name of the SignType, or "Class Name".

Sets a new Protocol if <enforce> is False and the new Protocol equates the old one then nothing is done.

Returns the Protocol. Warning: it can be Null.

Returns the GeneralLib itself.

Reservates maps for a count of entities <enforce> False : minimum count <enforce> True : clears former reservations Does not clear the maps.

Clears the maps which record, for each already recorded entity its Module and Case Number.

From a CDL Type Name, returns the Class part (package dropped) WARNING : buffered, to be immediately copied or printed.

Returns true if a template is attached to a given name.

Returns the template model attached to a name, or a Null Handle.

Records a new template model with a name. If the name was already recorded, the corresponding template is replaced by the new one. Then, WARNING : test HasTemplate to avoid surprises.

Returns the complete list of names attached to template models.

Clears the list of entities (service WhenDelete).

Sets a Protocol for this Model It is also set by a call to AddWithRefs with Protocol It is used for : DumpHeader (as required), ClearEntities ...

Returns the Protocol which has been set by SetProtocol, or AddWithRefs with Protocol.

Sets a GTool for this model, which already defines a Protocol.

Returns the GTool, set by SetProtocol or by SetGTool.

Returns the Dispatch Status, either for get or set A Model which is produced from Dispatch may share entities with the original (according to the Protocol), hence these non-copied entities should not be deleted.

Erases contained data; used when a Model is copied to others : the new copied ones begin from clear Clear calls specific method ClearHeader (see below).

Clears the entities; uses the general service WhenDelete, in addition to the standard Memory Manager; can be redefined.

Erases information about labels, if any : specific to each norm.

Clears Model's header : specific to each norm.

Returns count of contained Entities.

Returns True if a Model contains an Entity (for a ReportEntity, looks for the ReportEntity itself AND its Concerned Entity).

Returns the Number of an Entity in the Model if it contains it. Else returns 0. For a ReportEntity, looks at Concerned Entity. Returns the Directory entry Number of an Entity in the Model if it contains it. Else returns 0. For a ReportEntity, looks at Concerned Entity.

Returns an Entity identified by its number in the Model Each sub-class of InterfaceModel can define its own method Entity to return its specific class of Entity (e.g. for VDA, VDAModel returns a VDAEntity), working by calling Value Remark : For a Reported Entity, (Erroneous, Corrected, Unknown), this method returns this Reported Entity. See ReportEntity for other questions.

Returns the count of DISTINCT types under which an entity may be processed. Defined by the Protocol, which gives default as 1 (dynamic Type).

Returns a type, given its rank : defined by the Protocol (by default, the first one).

Returns the type name of an entity, from the list of types (one or more ...) <complete> True (D) gives the complete type, else packages are removed WARNING : buffered, to be immediately copied or printed.

Returns the State of an entity, given its number.

Returns True if <num> identifies a ReportEntity in the Model Hence, ReportEntity can be called.
By default, queries main report, if <semantic> is True, it queries report for semantic check
Remember that a Report Entity can be defined for an Unknown Entity, or a Corrected or Erroneous (at read time) Entity. The ReportEntity is defined before call to method AddEntity.

Returns a ReportEntity identified by its number in the Model, or a Null Handle If <num> does not identify a ReportEntity.
By default, queries main report, if <semantic> is True, it queries report for semantic check

Returns True if <num> identifies an Error Entity : in this case, a ReportEntity brings Fail Messages and possibly an "undefined" Content, see IsRedefinedEntity.

Returns True if <num> identifies an Entity which content is redefined through a ReportEntity (i.e. with literal data only) This happens when an entity is syntactically erroneous in the way that its basic content remains empty. For more details (such as content itself), see ReportEntity.

Removes the ReportEntity attached to Entity <num>. Returns True if done, False if no ReportEntity was attached to <num>. Warning : the caller must assume that this clearing is meaningful.

Sets or Replaces a ReportEntity for the Entity <num>. Returns True if Report is replaced, False if it has been replaced Warning : the caller must assume that this setting is meaningful.

Adds a ReportEntity as such. Returns False if the concerned entity is not recorded in the Model Else, adds it into, either the main report list or the list for semantic checks, then returns True.

Returns True if <num> identifies an Unknown Entity : in this case, a ReportEntity with no Check Messages designates it.

Returns True if semantic checks have been filled.