[occt.git] / src / IGESSelect / IGESSelect_SetGlobalParameter.cdl

-- File:	IGESSelect_SetGlobalParameter.cdl
-- Created:	Wed Jun  1 17:01:32 1994
-- Author:	Modelistation
--		<model@bravox>
---Copyright:	 Matra Datavision 1994


class SetGlobalParameter  from IGESSelect  inherits ModelModifier from IGESSelect

    ---Purpose : Sets a Global (Header) Parameter to a new value, directly given
    --           Controls the form of the parameter (Integer, Real, String
    --           with such or such form), but not the consistence of the new
    --           value regarding the rest of the file.
    --           
    --           The new value is given under the form of a HAsciiString, even
    --           for Integer or Real values. For String values, Hollerith forms
    --           are accepted but not mandatory
    --  Warning : a Null (not set) value is not accepted. For an empty string,
    --           give a Text Parameter which is empty

uses AsciiString from TCollection, HAsciiString from TCollection,
     IGESModel, CopyTool, ContextModif

is

    Create (numpar : Integer) returns mutable SetGlobalParameter;
    ---Purpose : Creates an SetGlobalParameter, to be applied on Global
    --           Parameter <numpar>

    GlobalNumber (me) returns Integer;
    ---Purpose : Returns the global parameter number to which this modifiers
    --           applies

    SetValue (me : mutable; text : mutable HAsciiString);
    ---Purpose : Sets a Text Parameter for the new value

    Value (me) returns mutable HAsciiString;
    ---Purpose : Returns the value to set to the global parameter (Text Param)


    Performing (me; ctx : in out ContextModif;
    	        target  : mutable IGESModel;
                TC      : in out CopyTool);
    ---Purpose : Specific action : only <target> is used : the form of the new
    --           value is checked regarding the parameter number (given at
    --           creation time).

    Label (me) returns AsciiString from TCollection;
    ---Purpose : Returns a text which is
    --           "Sets Global Parameter <numpar> to <new value>"

fields

    thenum : Integer;
    theval : HAsciiString from TCollection;

end SetGlobalParameter;
Commit	Line	Data
7fd59977	1	-- File: IGESSelect_SetGlobalParameter.cdl
	2	-- Created: Wed Jun 1 17:01:32 1994
	3	-- Author: Modelistation
	4	-- <model@bravox>
	5	---Copyright: Matra Datavision 1994
	6
	7
	8	class SetGlobalParameter from IGESSelect inherits ModelModifier from IGESSelect
	9
	10	---Purpose : Sets a Global (Header) Parameter to a new value, directly given
	11	-- Controls the form of the parameter (Integer, Real, String
	12	-- with such or such form), but not the consistence of the new
	13	-- value regarding the rest of the file.
	14	--
	15	-- The new value is given under the form of a HAsciiString, even
	16	-- for Integer or Real values. For String values, Hollerith forms
	17	-- are accepted but not mandatory
	18	-- Warning : a Null (not set) value is not accepted. For an empty string,
	19	-- give a Text Parameter which is empty
	20
	21	uses AsciiString from TCollection, HAsciiString from TCollection,
	22	IGESModel, CopyTool, ContextModif
	23
	24	is
	25
	26	Create (numpar : Integer) returns mutable SetGlobalParameter;
	27	---Purpose : Creates an SetGlobalParameter, to be applied on Global
	28	-- Parameter <numpar>
	29
	30	GlobalNumber (me) returns Integer;
	31	---Purpose : Returns the global parameter number to which this modifiers
	32	-- applies
	33
	34	SetValue (me : mutable; text : mutable HAsciiString);
	35	---Purpose : Sets a Text Parameter for the new value
	36
	37	Value (me) returns mutable HAsciiString;
	38	---Purpose : Returns the value to set to the global parameter (Text Param)
	39
	40
	41	Performing (me; ctx : in out ContextModif;
	42	target : mutable IGESModel;
	43	TC : in out CopyTool);
	44	---Purpose : Specific action : only <target> is used : the form of the new
	45	-- value is checked regarding the parameter number (given at
	46	-- creation time).
	47
	48	Label (me) returns AsciiString from TCollection;
	49	---Purpose : Returns a text which is
	50	-- "Sets Global Parameter <numpar> to <new value>"
	51
	52	fields
	53
	54	thenum : Integer;
	55	theval : HAsciiString from TCollection;
	56
	57	end SetGlobalParameter;