include/opencascade/IGESSelect_ChangeLevelNumber.hxx

0001 // Created on: 1994-08-25
0002 // Created by: Christian CAILLET
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_ChangeLevelNumber_HeaderFile
0018 #define _IGESSelect_ChangeLevelNumber_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESSelect_ModelModifier.hxx>
0024 class IFSelect_IntParam;
0025 class IFSelect_ContextModif;
0026 class IGESData_IGESModel;
0027 class Interface_CopyTool;
0028 class TCollection_AsciiString;
0029
0030 class IGESSelect_ChangeLevelNumber;
0031 DEFINE_STANDARD_HANDLE(IGESSelect_ChangeLevelNumber, IGESSelect_ModelModifier)
0032
0033 //! Changes Level Number (as null or single) to a new single value
0034 //! Entities attached to a LevelListEntity are ignored
0035 //! Entities considered can be, either all Entities but those
0036 //! attached to a LevelListEntity, or Entities attached to a
0037 //! specific Level Number (0 for not defined).
0038 //!
0039 //! Remark : this concerns the Directory Part only. The Level List
0040 //! Entities themselves (their content) are not affected.
0041 class IGESSelect_ChangeLevelNumber : public IGESSelect_ModelModifier
0042 {
0043
0044 public:
0045   //! Creates a ChangeLevelNumber, not yet defined
0046   //! (see SetOldNumber and SetNewNumber)
0047   Standard_EXPORT IGESSelect_ChangeLevelNumber();
0048
0049   //! Returns True if OldNumber is defined : then, only entities
0050   //! attached to the value of OldNumber will be considered. Else,
0051   //! all entities but those attached to a Level List will be.
0052   Standard_EXPORT Standard_Boolean HasOldNumber() const;
0053
0054   //! Returns the parameter for OldNumber. If not defined (Null
0055   //! Handle), it will be interpreted as "all level numbers"
0056   Standard_EXPORT Handle(IFSelect_IntParam) OldNumber() const;
0057
0058   //! Sets a parameter for OldNumber
0059   Standard_EXPORT void SetOldNumber(const Handle(IFSelect_IntParam)& param);
0060
0061   //! Returns the parameter for NewNumber. If not defined (Null
0062   //! Handle), it will be interpreted as "new value 0"
0063   Standard_EXPORT Handle(IFSelect_IntParam) NewNumber() const;
0064
0065   //! Sets a parameter for NewNumber
0066   Standard_EXPORT void SetNewNumber(const Handle(IFSelect_IntParam)& param);
0067
0068   //! Specific action : considers selected target entities :
0069   //! If OldNumber is not defined, all entities but those attached
0070   //! to a Level List
0071   //! If OldNumber is defined (value not negative), entities with a
0072   //! defined Level Number (can be zero)
0073   //! Attaches all these entities to value given by NewNumber, or
0074   //! zero if not defined
0075   Standard_EXPORT void Performing(IFSelect_ContextModif&            ctx,
0076                                   const Handle(IGESData_IGESModel)& target,
0077                                   Interface_CopyTool&               TC) const Standard_OVERRIDE;
0078
0079   //! Returns a text which is
0080   //! "Changes Level Number <old> to <new>" , or
0081   //! "Changes all Levels Numbers positive and zero to <new>"
0082   Standard_EXPORT TCollection_AsciiString Label() const Standard_OVERRIDE;
0083
0084   DEFINE_STANDARD_RTTIEXT(IGESSelect_ChangeLevelNumber, IGESSelect_ModelModifier)
0085
0086 protected:
0087 private:
0088   Handle(IFSelect_IntParam) theold;
0089   Handle(IFSelect_IntParam) thenew;
0090 };
0091
0092 #endif // _IGESSelect_ChangeLevelNumber_HeaderFile