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 class IGESSelect_SetGlobalParameter;
0032 DEFINE_STANDARD_HANDLE(IGESSelect_SetGlobalParameter, IGESSelect_ModelModifier)
0033
0034 //! Sets a Global (Header) Parameter to a new value, directly given
0035 //! Controls the form of the parameter (Integer, Real, String
0036 //! with such or such form), but not the consistence of the new
0037 //! value regarding the rest of the file.
0038 //!
0039 //! The new value is given under the form of a HAsciiString, even
0040 //! for Integer or Real values. For String values, Hollerith forms
0041 //! are accepted but not mandatory
0042 //! Warning : a Null (not set) value is not accepted. For an empty string,
0043 //! give a Text Parameter which is empty
0044 class IGESSelect_SetGlobalParameter : public IGESSelect_ModelModifier
0045 {
0046
0047 public:
0048   //! Creates an SetGlobalParameter, to be applied on Global
0049   //! Parameter <numpar>
0050   Standard_EXPORT IGESSelect_SetGlobalParameter(const Standard_Integer numpar);
0051
0052   //! Returns the global parameter number to which this modifiers
0053   //! applies
0054   Standard_EXPORT Standard_Integer GlobalNumber() const;
0055
0056   //! Sets a Text Parameter for the new value
0057   Standard_EXPORT void SetValue(const Handle(TCollection_HAsciiString)& text);
0058
0059   //! Returns the value to set to the global parameter (Text Param)
0060   Standard_EXPORT Handle(TCollection_HAsciiString) Value() const;
0061
0062   //! Specific action : only <target> is used : the form of the new
0063   //! value is checked regarding the parameter number (given at
0064   //! creation time).
0065   Standard_EXPORT void Performing(IFSelect_ContextModif&            ctx,
0066                                   const Handle(IGESData_IGESModel)& target,
0067                                   Interface_CopyTool&               TC) const Standard_OVERRIDE;
0068
0069   //! Returns a text which is
0070   //! "Sets Global Parameter <numpar> to <new value>"
0071   Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
0072
0073   DEFINE_STANDARD_RTTIEXT(IGESSelect_SetGlobalParameter, IGESSelect_ModelModifier)
0074
0075 protected:
0076 private:
0077   Standard_Integer                 thenum;
0078   Handle(TCollection_HAsciiString) theval;
0079 };
0080
0081 #endif // _IGESSelect_SetGlobalParameter_HeaderFile