src/IGESSelect/IGESSelect_SetGlobalParameter.cdl

   1 -- Created on: 1994-06-01
   2 -- Created by: Modelistation
   3 -- Copyright (c) 1994-1999 Matra Datavision
   4 -- Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 --
   6 -- This file is part of Open CASCADE Technology software library.
   7 --
   8 -- This library is free software; you can redistribute it and/or modify it under
   9 -- the terms of the GNU Lesser General Public License version 2.1 as published
  10 -- by the Free Software Foundation, with special exception defined in the file
  11 -- OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 -- distribution for complete text of the license and disclaimer of any warranty.
  13 --
  14 -- Alternatively, this file may be used under the terms of Open CASCADE
  15 -- commercial license or contractual agreement.
  16
  17 class SetGlobalParameter  from IGESSelect  inherits ModelModifier from IGESSelect
  18
  19     ---Purpose : Sets a Global (Header) Parameter to a new value, directly given
  20     --           Controls the form of the parameter (Integer, Real, String
  21     --           with such or such form), but not the consistence of the new
  22     --           value regarding the rest of the file.
  23     --
  24     --           The new value is given under the form of a HAsciiString, even
  25     --           for Integer or Real values. For String values, Hollerith forms
  26     --           are accepted but not mandatory
  27     --  Warning : a Null (not set) value is not accepted. For an empty string,
  28     --           give a Text Parameter which is empty
  29
  30 uses AsciiString from TCollection, HAsciiString from TCollection,
  31      IGESModel, CopyTool, ContextModif
  32
  33 is
  34
  35     Create (numpar : Integer) returns SetGlobalParameter;
  36     ---Purpose : Creates an SetGlobalParameter, to be applied on Global
  37     --           Parameter <numpar>
  38
  39     GlobalNumber (me) returns Integer;
  40     ---Purpose : Returns the global parameter number to which this modifiers
  41     --           applies
  42
  43     SetValue (me : mutable; text : HAsciiString);
  44     ---Purpose : Sets a Text Parameter for the new value
  45
  46     Value (me) returns HAsciiString;
  47     ---Purpose : Returns the value to set to the global parameter (Text Param)
  48
  49
  50     Performing (me; ctx : in out ContextModif;
  51                 target  : IGESModel;
  52                 TC      : in out CopyTool);
  53     ---Purpose : Specific action : only <target> is used : the form of the new
  54     --           value is checked regarding the parameter number (given at
  55     --           creation time).
  56
  57     Label (me) returns AsciiString from TCollection;
  58     ---Purpose : Returns a text which is
  59     --           "Sets Global Parameter <numpar> to <new value>"
  60
  61 fields
  62
  63     thenum : Integer;
  64     theval : HAsciiString from TCollection;
  65
  66 end SetGlobalParameter;