include/opencascade/IGESSelect_SetGlobalParameter.hxx

0001 // Created on: 1994-06-01
0002 // Created by: Modelistation
0003 // Copyright (c) 1994-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESSelect_SetGlobalParameter_HeaderFile
0018 #define _IGESSelect_SetGlobalParameter_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <Standard_Integer.hxx>
0024 #include <IGESSelect_ModelModifier.hxx>
0025 class TCollection_HAsciiString;
0026 class IFSelect_ContextModif;
0027 class IGESData_IGESModel;
0028 class Interface_CopyTool;
0029 class TCollection_AsciiString;
0030
0031
0032 class IGESSelect_SetGlobalParameter;
0033 DEFINE_STANDARD_HANDLE(IGESSelect_SetGlobalParameter, IGESSelect_ModelModifier)
0034
0035 //! Sets a Global (Header) Parameter to a new value, directly given
0036 //! Controls the form of the parameter (Integer, Real, String
0037 //! with such or such form), but not the consistence of the new
0038 //! value regarding the rest of the file.
0039 //!
0040 //! The new value is given under the form of a HAsciiString, even
0041 //! for Integer or Real values. For String values, Hollerith forms
0042 //! are accepted but not mandatory
0043 //! Warning : a Null (not set) value is not accepted. For an empty string,
0044 //! give a Text Parameter which is empty
0045 class IGESSelect_SetGlobalParameter : public IGESSelect_ModelModifier
0046 {
0047
0048 public:
0049
0050
0051   //! Creates an SetGlobalParameter, to be applied on Global
0052   //! Parameter <numpar>
0053   Standard_EXPORT IGESSelect_SetGlobalParameter(const Standard_Integer numpar);
0054
0055   //! Returns the global parameter number to which this modifiers
0056   //! applies
0057   Standard_EXPORT Standard_Integer GlobalNumber() const;
0058
0059   //! Sets a Text Parameter for the new value
0060   Standard_EXPORT void SetValue (const Handle(TCollection_HAsciiString)& text);
0061
0062   //! Returns the value to set to the global parameter (Text Param)
0063   Standard_EXPORT Handle(TCollection_HAsciiString) Value() const;
0064
0065   //! Specific action : only <target> is used : the form of the new
0066   //! value is checked regarding the parameter number (given at
0067   //! creation time).
0068   Standard_EXPORT void Performing (IFSelect_ContextModif& ctx, const Handle(IGESData_IGESModel)& target, Interface_CopyTool& TC) const Standard_OVERRIDE;
0069
0070   //! Returns a text which is
0071   //! "Sets Global Parameter <numpar> to <new value>"
0072   Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
0073
0074
0075
0076
0077   DEFINE_STANDARD_RTTIEXT(IGESSelect_SetGlobalParameter,IGESSelect_ModelModifier)
0078
0079 protected:
0080
0081
0082
0083
0084 private:
0085
0086
0087   Standard_Integer thenum;
0088   Handle(TCollection_HAsciiString) theval;
0089
0090
0091 };
0092
0093
0094
0095
0096
0097
0098
0099 #endif // _IGESSelect_SetGlobalParameter_HeaderFile