0030675: Visualization - remove redundant proxy classes in hierarchy of PrsMgr_Presen...
[occt.git] / src / IGESSelect / IGESSelect_SetGlobalParameter.hxx
CommitLineData
42cf5bc1 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#ifndef _IGESSelect_SetGlobalParameter_HeaderFile
18#define _IGESSelect_SetGlobalParameter_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_Type.hxx>
22
23#include <Standard_Integer.hxx>
24#include <IGESSelect_ModelModifier.hxx>
25class TCollection_HAsciiString;
26class IFSelect_ContextModif;
27class IGESData_IGESModel;
28class Interface_CopyTool;
29class TCollection_AsciiString;
30
31
32class IGESSelect_SetGlobalParameter;
33DEFINE_STANDARD_HANDLE(IGESSelect_SetGlobalParameter, IGESSelect_ModelModifier)
34
35//! Sets a Global (Header) Parameter to a new value, directly given
36//! Controls the form of the parameter (Integer, Real, String
37//! with such or such form), but not the consistence of the new
38//! value regarding the rest of the file.
39//!
40//! The new value is given under the form of a HAsciiString, even
41//! for Integer or Real values. For String values, Hollerith forms
42//! are accepted but not mandatory
43//! Warning : a Null (not set) value is not accepted. For an empty string,
44//! give a Text Parameter which is empty
45class IGESSelect_SetGlobalParameter : public IGESSelect_ModelModifier
46{
47
48public:
49
50
51 //! Creates an SetGlobalParameter, to be applied on Global
52 //! Parameter <numpar>
53 Standard_EXPORT IGESSelect_SetGlobalParameter(const Standard_Integer numpar);
54
55 //! Returns the global parameter number to which this modifiers
56 //! applies
57 Standard_EXPORT Standard_Integer GlobalNumber() const;
58
59 //! Sets a Text Parameter for the new value
60 Standard_EXPORT void SetValue (const Handle(TCollection_HAsciiString)& text);
61
62 //! Returns the value to set to the global parameter (Text Param)
63 Standard_EXPORT Handle(TCollection_HAsciiString) Value() const;
64
65 //! Specific action : only <target> is used : the form of the new
66 //! value is checked regarding the parameter number (given at
67 //! creation time).
79104795 68 Standard_EXPORT void Performing (IFSelect_ContextModif& ctx, const Handle(IGESData_IGESModel)& target, Interface_CopyTool& TC) const Standard_OVERRIDE;
42cf5bc1 69
70 //! Returns a text which is
71 //! "Sets Global Parameter <numpar> to <new value>"
79104795 72 Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
42cf5bc1 73
74
75
76
92efcf78 77 DEFINE_STANDARD_RTTIEXT(IGESSelect_SetGlobalParameter,IGESSelect_ModelModifier)
42cf5bc1 78
79protected:
80
81
82
83
84private:
85
86
87 Standard_Integer thenum;
88 Handle(TCollection_HAsciiString) theval;
89
90
91};
92
93
94
95
96
97
98
99#endif // _IGESSelect_SetGlobalParameter_HeaderFile