include/opencascade/TNaming_Scope.hxx

0001 // Created on: 1999-11-03
0002 // Created by: Denis PASCAL
0003 // Copyright (c) 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 _TNaming_Scope_HeaderFile
0018 #define _TNaming_Scope_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TDF_LabelMap.hxx>
0025 class TDF_Label;
0026 class TopoDS_Shape;
0027 class TNaming_NamedShape;
0028
0029
0030 //! this class manage a scope of labels
0031 //! ===================================
0032 class TNaming_Scope
0033 {
0034 public:
0035
0036   DEFINE_STANDARD_ALLOC
0037
0038
0039   //! WithValid = FALSE
0040   Standard_EXPORT TNaming_Scope();
0041
0042   //! if <WithValid> the scope is defined by the map. If not
0043   //! on the whole framework.
0044   Standard_EXPORT TNaming_Scope(const Standard_Boolean WithValid);
0045
0046   //! create a scope with a map. WithValid = TRUE.
0047   Standard_EXPORT TNaming_Scope(TDF_LabelMap& valid);
0048
0049   Standard_EXPORT Standard_Boolean WithValid() const;
0050
0051   Standard_EXPORT void WithValid (const Standard_Boolean mode);
0052
0053   Standard_EXPORT void ClearValid();
0054
0055   Standard_EXPORT void Valid (const TDF_Label& L);
0056
0057   Standard_EXPORT void ValidChildren (const TDF_Label& L, const Standard_Boolean withroot = Standard_True);
0058
0059   Standard_EXPORT void Unvalid (const TDF_Label& L);
0060
0061   Standard_EXPORT void UnvalidChildren (const TDF_Label& L, const Standard_Boolean withroot = Standard_True);
0062
0063   Standard_EXPORT Standard_Boolean IsValid (const TDF_Label& L) const;
0064
0065   Standard_EXPORT const TDF_LabelMap& GetValid() const;
0066
0067   Standard_EXPORT TDF_LabelMap& ChangeValid();
0068
0069   //! Returns  the current  value of  <NS> according to the
0070   //! Valid Scope.
0071   Standard_EXPORT TopoDS_Shape CurrentShape (const Handle(TNaming_NamedShape)& NS) const;
0072
0073
0074
0075
0076 protected:
0077
0078
0079
0080
0081
0082 private:
0083
0084
0085
0086   Standard_Boolean myWithValid;
0087   TDF_LabelMap myValid;
0088
0089
0090 };
0091
0092
0093
0094
0095
0096
0097
0098 #endif // _TNaming_Scope_HeaderFile