MoniTool

Adds an attribute with a given name (replaces the former one with the same name if already exists).

Removes an attribute Returns True when done, False if this attribute did not exist.

Returns an attribute from its name, filtered by a type If no attribute has this name, or if it is not kind of this type, <val> is Null and returned value is False Else, it is True.

Returns an attribute from its name. Null Handle if not recorded (whatever Transient, Integer, Real ...) Integer is recorded as IntVal Real is recorded as RealVal Text is recorded as HAsciiString.

Returns the type of an attribute: ValueInt, ValueReal, ValueText (String), ValueIdent (any) or ValueVoid (not recorded).

Adds an integer value for an attribute.

Returns an attribute from its name, as integer If no attribute has this name, or not an integer, <val> is 0 and returned value is False Else, it is True.

Returns an integer attribute from its name. 0 if not recorded.

Adds a real value for an attribute.

Returns an attribute from its name, as real If no attribute has this name, or not a real <val> is 0.0 and returned value is False Else, it is True.

Returns a real attribute from its name. 0.0 if not recorded.

Adds a String value for an attribute.

Returns a String attribute from its name. "" if not recorded.

Returns the exhaustive list of attributes.

Gets the list of attributes from <other>, as such, i.e. not copied : attributes are shared, any attribute edited, added, or removed in <other> is also in <me> and vice versa The former list of attributes of <me> is dropped.

Gets the list of attributes from <other>, by copying it By default, considers all the attributes from <other> If <fromname> is given, considers only the attributes with name beginning by <fromname>.
For each attribute, if <copied> is True (D), its value is also copied if it is a basic type (Integer,Real,String), else it remains shared between <other> and <me>
These new attributes are added to the existing ones in <me>, in case of same name, they replace the existing ones

Creates a CaseData with a CaseId and a Name (by default not defined).

Sets a Code to give a Warning.

Sets a Code to give a Fail.

Returns Check Status for a Code : 0 non/info (default), 1 warning, 2 fail.
Remark : DefCheck is used to set the check status of a CaseData when it is attached to a case code, it can be changed later (by SetFail, SetWarning, ResetCheck)

Attaches a message definition to a case code This definition includes the message code plus designation of items of the CaseData to be added to the message (this part not yet implemented).

Returns the message definition for a case code Empty if no message attached.

Sets a CaseId.

Sets a Name.

Returns the CaseId.

Tells if <me> is Check (Warning or Fail), else it is Info.

Tells if <me> is Warning.

Tells if <me> is Fail.

Resets Check Status, i.e. sets <me> as Info.

Sets <me> as Warning.

Sets <me> as Fail.

Sets the next Add... not to add but to change the data item designated by its name. If next Add... is not called with a name, SetChange is ignored Reset by next Add... , whatever <num> is correct or not.

Sets the next Add... not to add but to replace the data item <num>, if <num> is between 1 and NbData. Reset by next Add... , whatever <num> is correct or not.

Unitary adding a data; rather internal.

Adds the currently caught exception.

Adds a Shape (recorded as a HShape).

Adds a XYZ.

Adds a XY.

Adds a Real.

Adds two reals (for instance, two parameters).

Adds the CPU time between lastCPU and now if <curCPU> is given, the CPU amount is curCPU-lastCPU else it is currently measured CPU - lastCPU lastCPU has been read by call to GetCPU See GetCPU to get amount, and LargeCPU to test large amount.

Returns the current amount of CPU This allows to laterly test and record CPU amount Its value has to be given to LargeCPU and AddCPU.

Tells if a CPU time amount is large <maxCPU> gives the amount over which an amount is large <lastCPU> gives the start CPU amount if <curCPU> is given, the tested CPU amount is curCPU-lastCPU else it is currently measured CPU - lastCPU.

Adds a Geometric as a Transient (Curve, Surface ...).

Adds a Transient, as an Entity from an InterfaceModel for instance : it will then be printed with the help of a DBPE.

Adds a Text (as HAsciiString).

Adds an Integer.

Adds a Transient, with no more meaning.

Removes a Data from its rank. Does nothing if out of range.

Returns the count of data recorded to a set.

Returns a data item (n0 <nd> in the set <num>).

Returns a data item, under control of a Type If the data item is kind of this type, it is returned in <val> and the returned value is True Else, <val> is unchanged and the returned value is False.

Returns the kind of a data : KIND TYPE MEANING 0 ANY any (not one of the following) 1 EX raised exception 2 EN entity 3 G geom 4 SH shape 5 XYZ XYZ 6 XY or UV XY 7 RR 2 reals 8 R 1 real 9 CPU CPU (1 real) 10 T text 11 I integer.
For NameNum, these codes for TYPE must be given exact i.e. SH for a Shape, not S nor SHAPE nor SOLID etc

Returns the first suitable data rank for a given name Exact matching (exact case, no completion) is required Firstly checks the recorded names If not found, considers the name as follows : Name = "TYPE" : search for the first item with this TYPE Name = "TYPE:nn" : search for the nn.th item with this TYPE See allowed values in method Kind.

Returns a data as a shape, Null if not a shape.

Returns a data as a XYZ (i.e. Geom_CartesianPoint) Returns False if not the good type.

Returns a data as a XY (i.e. Geom2d_CartesianPoint) Returns False if not the good type.

Returns a couple of reals (stored in Geom2d_CartesianPoint).

Returns a real or CPU amount (stored in Geom2d_CartesianPoint) (allows an Integer converted to a Real).

Returns an Integer.

Returns a Msg from a CaseData : it is build from DefMsg, which gives the message code plus the designation of items of the CaseData to be added to the Msg Empty if no message attached.
Remains to be implemented

Returns the Type attached to an object Here, the Dynamic Type of a Transient. Null Type if unknown.

Returns Type Name (string) Allows to name type of non-handled objects.

Returns the HashCode which has been stored by SetHashCode (remark that HashCode could be deferred then be defined by sub-classes, the result is the same).

Specific testof equality : to be defined by each sub-class, must be False if Elements have not the same true Type, else their contents must be compared.

Returns the Type of the Value. By default, returns the DynamicType of <me>, but can be redefined.

Returns the name of the Type of the Value. Default is name of ValueType, unless it is for a non-handled object.

Returns (readonly) the Attribute List.

Returns (modifiable) the Attribute List.

Returns "SHAPE".

Returns for a HShape, the string of its ShapeEnum The Model is absolutely useless (may be null).

Returns an identification of the Signature (a word), given at initialization time.

Gives a text as a signature for a transient object alone, i.e. without defined context. By default, calls Text with undefined context (Null Handle) and if empty, then returns DynamicType.

Gives a text as a signature for a transient object in a context If the context is senseless, it can be given as Null Handle empty result if nothing to give (at least the DynamicType could be sent ?).

Opens a new counter with a starting count of items.

Adds more items to be counted by Add... on current level.

Directly adds items.

Declares a count of items to be added later. If a sub-counter is opened, its percentage multiplies this sub-count to compute the percent of current level.

Ends the AddSub and cumulates the sub-count to current level.

Create timer in empty state.

Inline methods to conveniently start/stop timer by name Shortcut to Timer(name)->Start/Stop().

Returns a timer from a dictionary by its name If timer not existed, creates a new one.

Returns map of timers.

Clears map of timers.

Computes and remembers amendments for times to access, start, and stop of timer, and estimates second-order error measured by 10 nested timers.

The computed amendmens are returned (for information only).

Start, Stop and reset the timer In addition to doing that to embedded OSD_Timer, manage also counter of hits.

Return value of hits counter (count of Start/Stop pairs).

Returns value of nesting counter.

Return value of CPU time minus accumulated amendment.

Return value of accumulated amendment on CPU time.

Manually stops the timer.

Creates a TransientElem with a Value. This Value can then not be changed. It is used by the Hasher to compute the HashCode, which will then be stored for an immediate reading.

Returns the contained value.

Specific testof equality : defined as False if <other> has not the same true Type, else contents are compared (by C++ operator ==).

Returns the Type of the Value. By default, returns the DynamicType of <me>, but can be redefined.

Returns the name of the Type of the Value. Default is name of ValueType, unless it is for a non-handled object.

Adds a TypedValue in the library. It is recorded then will be accessed by its Name Its Definition may be imposed, else it is computed as usual By default it will be accessed by its Definition (string) Returns True if done, False if tv is Null or brings no Definition or <def> not defined.
If a TypedValue was already recorded under this name, it is replaced

Returns the TypedValue bound with a given Name Null Handle if none recorded Warning: it is the original, not duplicated.

Returns a COPY of the TypedValue bound with a given Name Null Handle if none recorded.

Returns the list of names of items of the Library of Types Library of TypedValue as Valued Parameters, accessed by parameter name for use by management of Static Parameters.

Returns a static value from its name, null if unknown.

Returns the name.

Returns the type of the value.

Returns the Definition By priority, the enforced one, else an automatic one, computed from the specification.

Enforces a Definition.

Completes the definition of a TypedValue by command <initext>, once created with its type Returns True if done, False if could not be interpreted <initext> may be : imin ival : minimum value for an integer imax ival : maximum value for an integer rmin rval : minimum value for a real rmax rval : maximum value for a real unit name : name of unit ematch i : enum from integer value i, match required enum i : enum from integer value i, match not required eval text : add an enumerative value (increments max by 1) eval ?? : add a non-authorised enum value (to be skipped) tmax l : maximum length for a text.

Sets a label, which can then be displayed.

Returns the label, if set; else returns an empty string.

Sets a maximum length for a text (active only for a free text).

Returns the maximum length, 0 if not set.

Sets an Integer limit (included) to <val>, the upper limit if <max> is True, the lower limit if <max> is False.

Gives an Integer Limit (upper if <max> True, lower if <max> False). Returns True if this limit is defined, False else (in that case, gives the natural limit for Integer).

Sets a Real limit (included) to <val>, the upper limit if <max> is True, the lower limit if <max> is False.

Gives an Real Limit (upper if <max> True, lower if <max> False). Returns True if this limit is defined, False else (in that case, gives the natural limit for Real).

Sets (Clears if <def> empty) a unit definition, as an equation of dimensions. TypedValue just records this definition, does not exploit it, to be done as required by user applications.

Returns the recorded unit definition, empty if not set.

For an enumeration, precises the starting value (default 0) and the match condition : if True (D), the string value must match the definition, else it may take another value : in that case, the Integer Value will be Start - 1. (empty value remains allowed).

Adds enumerative definitions. For more than 10, several calls.

Adds an enumeration definition, by its string and numeric values. If it is the first setting for this value, it is recorded as main value. Else, it is recognized as alternate string for this numeric value.

Gives the Enum definitions : start value, end value, match status. Returns True for an Enum, False else.

Returns the value of an enumerative definition, from its rank Empty string if out of range or not an Enum.

Returns the case number which corresponds to a string value Works with main and additional values Returns (StartEnum - 1) if not OK, -1 if not an Enum.

Sets type of which an Object TypedValue must be kind of Error for a TypedValue not an Object (Entity).

Returns the type of which an Object TypedValue must be kind of Default is Standard_Transient Null for a TypedValue not an Object.

Sets a specific Interpret function.

Tells if a TypedValue has an Interpret.

Sets a specific Satisfies function : it is added to the already defined criteria It must match the form : satisfies (val : HAsciiString) returns Boolean.

Returns name of specific satisfy, empty string if none.

Returns True if the value is set (not empty/not null object).

Returns the value, as a cstring. Empty if not set.

Returns the value, as a Handle (can then be shared) Null if not defined.

Interprets a value. <native> True : returns a native value <native> False : returns a coded value If the Interpret function is set, calls it Else, for an Enum, Native returns the Text, Coded returns the number STANDARD RETURNS : = hval means no specific interpretation Null means senseless Can also be redefined.

Returns True if a value statifies the specification (remark : does not apply to Entity : see ObjectType, for this type, the string is just a comment).

Clears the recorded Value : it is now unset.

Changes the value. The new one must satisfy the specification Returns False (and did not set) if the new value does not satisfy the specification Can be redefined to be managed (in a subclass).

Forces a new Handle for the Value It can be empty, else (if Type is not free Text), it must satisfy the specification. Not only the value is changed, but also the way it is shared Remark : for Type=Object, this value is not controlled, it can be set as a comment Returns False (and did not set) if the new value does not satisfy the specification Can be redefined to be managed (in a subclass).

Returns the value as integer, i.e. : For type = Integer, the integer itself; 0 if not set For type = Enum, the designated rank (see Enum definition) StartEnum - 1 if not set or not in the definition Else, returns 0.

Changes the value as an integer, only for Integer or Enum.

Returns the value as real, for a Real type TypedValue Else, returns 0.

Changes the value as a real, only for Real.

Returns the value as Transient Object, only for Object/Entity Remark that the "HString value" is IGNORED here Null if not set; remains to be casted.

Same as ObjectValue, but avoids DownCast : the receiving variable is directly loaded. It is assumed that it complies with the definition of ObjectType ! Otherwise, big trouble.

Changes the value as Transient Object, only for Object/Entity Returns False if DynamicType does not satisfy ObjectType Can be redefined to be managed (in a subclass).

Returns the type name of the ObjectValue, or an empty string if not set.