Integration of OCCT 6.5.0 from SVN

src/Interface/Interface_Static.cdl

@@ -0,0 +1,279 @@
+-- File:	Interface_Static.cdl
+-- Created:	Fri Dec  8 08:36:26 1995
+-- Author:	Christian CAILLET
+--		<cky@fidox>
+---Copyright:	 Matra Datavision 1995
+
+
+class Static  from Interface    inherits TypedValue  from Interface
+
+    ---Purpose : This class gives a way to manage meaningfull static variables,
+    --           used as "global" parameters in various procedures.
+    --           
+    --           A Static brings a specification (its type, constraints if any)
+    --           and a value. Its basic form is a string, it can be specified
+    --           as integer or real or enumerative string, and queried as such.
+    --           Its string content, which is a Handle(HAsciiString) can be
+    --           shared by other data structures, hence gives a direct on line
+    --           access to its value.
+    --           
+    --           All this description is inherited from TypedValue
+    --           
+    --           A Static can be given an initial value, it can be filled from,
+    --           either a set of Resources (an applicative feature which
+    --           accesses and manages parameter files), or environment or
+    --           internal definition : these define families of Static.
+    --           In addition, it supports a status for reinitialisation : an
+    --           initialisation procedure can ask if the value of the Static
+    --           has changed from its last call, in this case does something
+    --           then marks the Status "uptodate", else it does nothing.
+    --           
+    --           Statics are named and recorded then accessed in an alphabetic
+    --           dictionary
+
+uses CString, Type from Standard,
+     Messenger from Message,
+     AsciiString from TCollection, HAsciiString from TCollection,
+     HSequenceOfAsciiString  from TColStd, HArray1OfAsciiString  from TColStd,
+     HSequenceOfHAsciiString from TColStd,
+     DictionaryOfInteger from Dico,
+     ParamType from Interface , StaticSatisfies from Interface
+
+raises InterfaceError
+
+is
+
+    Create (family, name : CString;
+    	    type : ParamType from Interface = Interface_ParamText;
+	    init : CString = "")  returns mutable Static
+    ---Purpose : Creates and records a Static, with a family and a name
+    --           family can report to a name of ressource or to a system or
+    --           internal definition. The name must be unique.
+    --           
+    --           type gives the type of the parameter, default is free text
+    --           Also available : Integer, Real, Enum, Entity (i.e. Object)
+    --           More precise specifications, titles, can be given to the
+    --           Static once created
+    --           
+    --           init gives an initial value. If it is not given, the Static
+    --           begin as "not set", its value is empty
+    	raises InterfaceError;
+    --           Error if <name> is already recorded, or <type> not supported
+    --           See also class method Init
+
+    Create (family, name : CString; other : Static) returns mutable Static;
+    ---Purpose : Creates a new Static with same definition as another one
+    --           (value is copied, except for Entity : it remains null)
+
+    PrintStatic (me; S : Messenger from Message);
+    ---Purpose : Writes the properties of a
+-- parameter in the diagnostic file. These include:
+-- - Name
+-- - Family,
+-- - Wildcard (if it has one)
+-- - Current status (empty  string if it was updated or
+--   if it is the original one)
+-- - Value
+
+    Family (me) returns CString;
+    ---Purpose : Returns the family. It can be : a resource name for applis,
+    --           an internal name between : $e (environment variables),
+    --           $l (other, purely local)
+
+    SetWild  (me : mutable; wildcard : Static);
+    ---Purpose : Sets a "wild-card" static : its value will be considered
+    --           if <me> is not properly set. (reset by set a null one)
+
+    Wild     (me) returns Static;
+    ---Purpose : Returns the wildcard static, which can be (is most often) null
+
+    	-- --    Update Status    -- --
+
+    SetUptodate (me : mutable);
+    ---Purpose : Records a Static has "uptodate", i.e. its value has been taken
+    --           into account by a reinitialisation procedure
+    --           This flag is reset at each successful SetValue
+
+    UpdatedStatus (me) returns Boolean;
+    ---Purpose : Returns the status "uptodate"
+
+    	-- --
+    	-- --    Class methods : dictionary of statics    -- --
+    	-- --
+
+    Init (myclass; family, name : CString;
+    	    type : ParamType from Interface;
+	    init : CString = "")  returns Boolean;
+    ---Purpose : Declares a new Static (by calling its constructor)
+    --           If this name is already taken, does nothing and returns False
+    --           Else, creates it and returns True
+    --           For additional definitions, get the Static then edit it
+
+    Init (myclass; family, name : CString;
+    	    type : Character;
+	    init : CString = "")  returns Boolean;
+    ---Purpose : As Init with ParamType, but type is given as a character
+    --           This allows a simpler call
+    --           Types : 'i' Integer, 'r' Real, 't' Text, 'e' Enum, 'o' Object
+    --           '=' for same definition as, <init> gives the initial Static
+    --           Returns False if <type> does not match this list
+
+    Static (myclass; name : CString) returns mutable Static;
+    ---Purpose : Returns a Static from its name. Null Handle if not present
+
+    IsPresent (myclass; name : CString) returns Boolean;
+    ---Purpose : Returns True if a Static named <name> is present, False else
+
+    CDef (myclass; name : CString; part : CString) returns CString;
+    ---Purpose : Returns a part of the definition of a Static, as a CString
+    --           The part is designated by its name, as a CString
+    --           If the required value is not a string, it is converted to a
+    --           CString then returned
+    --           If <name> is not present, or <part> not defined for <name>,
+    --           this function returns an empty string
+    --           
+    --           Allowed parts for CDef :
+    --             family : the family
+    --             type  : the type ("integer","real","text","enum")
+    --             label : the label
+    --             satis : satisfy function name if any
+    --             rmin : minimum real value
+    --             rmax : maximum real value
+    --             imin : minimum integer value
+    --             imax : maximum integer value
+    --             enum nn (nn : value of an integer) : enum value for nn
+    --             unit : unit definition for a real
+
+    IDef (myclass; name : CString; part : CString) returns Integer;
+    ---Purpose : Returns a part of the definition of a Static, as an Integer
+    --           The part is designated by its name, as a CString
+    --           If the required value is not a string, returns zero
+    --           For a Boolean, 0 for false, 1 for true
+    --           If <name> is not present, or <part> not defined for <name>,
+    --           this function returns zero
+    --           
+    --           Allowed parts for IDef :
+    --             imin, imax : minimum or maximum integer value
+    --             estart : starting number for enum
+    --             ecount : count of enum values (starting from estart)
+    --             ematch : exact match status
+    --             eval val : case determined from a string
+
+    	--    Querying and Setting    --
+    	--    (must useful ones; for other, see methods of instance above)
+
+    IsSet     (myclass; name : CString; proper : Boolean = Standard_True)
+    	returns Boolean;
+    ---Purpose : Returns True if <name> is present AND set
+    --           <proper> True (D) : considers this item only
+    --           <proper> False    : if not set and attached to a wild-card,
+    --             considers this wild-card
+
+    CVal      (myclass; name : CString) returns CString;
+    ---Purpose : Returns the value of the
+-- parameter identified by the string name.
+-- If the specified parameter does not exist, an empty
+-- string is returned.
+-- Example
+-- Interface_Static::CVal("write.step.schema");
+-- which could return:
+-- "AP214"
+
+    IVal      (myclass; name : CString) returns Integer;
+    ---Purpose :  Returns the integer value of
+-- the translation parameter identified by the string name.
+-- Returns the value 0 if the parameter does not exist.
+-- Example
+-- Interface_Static::IVal("write.step.schema");
+-- which could return: 3
+    RVal      (myclass; name : CString) returns Real;
+    ---Purpose :  Returns the value of a static
+-- translation parameter identified by the string name.
+-- Returns the value 0.0 if the parameter does not exist.
+    SetCVal   (myclass; name : CString; val : CString) returns Boolean;
+    ---Purpose : Modifies the value of the
+-- parameter identified by name. The modification is specified
+-- by the string val. false is returned if the parameter does not exist.
+-- Example
+-- Interface_Static::SetCVal
+-- ("write.step.schema","AP203")
+-- This syntax specifies a switch from the default STEP 214 mode to STEP 203 mode.
+
+    SetIVal   (myclass; name : CString; val : Integer) returns Boolean;
+    ---Purpose : Modifies the value of the
+-- parameter identified by name. The modification is specified
+-- by the integer value val. false is returned if the
+-- parameter does not exist.
+-- Example
+-- Interface_Static::SetIVal
+-- ("write.step.schema", 3)
+-- This syntax specifies a switch from the default STEP 214 mode to STEP 203 mode.S
+
+    SetRVal   (myclass; name : CString; val : Real)    returns Boolean;
+    ---Purpose :  Modifies the value of a
+-- translation parameter. false is returned if the
+-- parameter does not exist. The modification is specified
+-- by the real number value val.
+
+    Update    (myclass; name : CString) returns Boolean;
+    ---Purpose : Sets a Static to be "uptodate"
+    --           Returns False if <name> is not present
+    --           This status can be used by a reinitialisation procedure to
+    --           rerun if a value has been changed
+
+    IsUpdated (myclass; name : CString) returns Boolean;
+    ---Purpose : Returns the status "uptodate" from a Static
+    --           Returns False if <name> is not present
+
+    Items     (myclass; mode : Integer = 0; criter : CString = "") returns HSequenceOfHAsciiString;
+    ---Purpose : Returns a list of names of statics :
+    --           <mode> = 0 (D) : criter is for family
+    --           <mode> = 1 : criter is regexp on names, takes final items
+    --             (ignore wild cards)
+    --           <mode> = 2 : idem but take only wilded, not final items
+    --           <mode> = 3 : idem, take all items matching criter
+    --           idem + 100 : takes only non-updated items
+    --           idem + 200 : takes only updated items
+    --           criter empty (D) : returns all names
+    --           else returns names which match the given criter
+    --           Remark : families beginning by '$' are not listed by criter ""
+    --           they are listed only by criter "$"
+    --           
+    --           This allows for instance to set new values after having loaded
+    --           or reloaded a resource, then to update them as required
+
+    	--  A special class method : initialisation of standard statics
+
+    Standards (myclass);
+    ---Purpose : Initializes all standard static parameters, which can be used
+    --           by every function. statics specific of a norm or a function
+    --           must be defined around it
+
+fields
+
+    thefamily : AsciiString;
+    thename   : AsciiString;
+    thelabel  : AsciiString;
+    thetype   : ParamType from Interface;
+    theotyp   : Type from Standard;  -- for object
+    thewild   : Static;
+
+    thelims   : Integer;  -- status for integer/enum/real limits
+    theintlow : Integer;
+    theintup  : Integer;
+    therealow : Real;
+    therealup : Real;
+    theunidef : AsciiString;
+
+    theenums  : HArray1OfAsciiString    from TColStd;
+    theeadds  : DictionaryOfInteger;
+
+    thesatisf : StaticSatisfies;
+    thesatisn : AsciiString;
+
+    theupdate : Boolean;
+    theival   : Integer;
+    thehval   : HAsciiString from TCollection;
+    theoval   : Transient;
+
+end Static;