0032743: Coding Rules - remove unused class friends of Package classes
[occt.git] / src / TopTools / TopTools.hxx
CommitLineData
42cf5bc1 1// Created on: 1993-01-14
2// Created by: Remi LEQUETTE
3// Copyright (c) 1993-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 _TopTools_HeaderFile
18#define _TopTools_HeaderFile
19
20#include <Standard.hxx>
21#include <Standard_DefineAlloc.hxx>
22#include <Standard_Handle.hxx>
23
24#include <Standard_OStream.hxx>
25#include <Standard_Integer.hxx>
26class TopoDS_Shape;
42cf5bc1 27
28
29//! The TopTools package provides utilities for the
30//! topological data structure.
31//!
32//! * ShapeMapHasher. Hash a Shape base on the TShape
33//! and the Location. The Orientation is not used.
34//!
35//! * OrientedShapeMapHasher. Hash a Shape base on the
36//! TShape ,the Location and the Orientation.
37//!
38//! * Instantiations of TCollection for Shapes :
39//! MapOfShape
40//! IndexedMapOfShape
41//! DataMapOfIntegerShape
42//! DataMapOfShapeInteger
43//! DataMapOfShapeReal
44//! Array1OfShape
45//! HArray1OfShape
46//! SequenceOfShape
47//! HSequenceOfShape
48//! ListOfShape
49//! Array1OfListShape
50//! HArray1OfListShape
51//! DataMapOfIntegerListOfShape
52//! DataMapOfShapeListOfShape
53//! DataMapOfShapeListOfInteger
54//! IndexedDataMapOfShapeShape
55//! IndexedDataMapOfShapeListOfShape
56//! DataMapOfShapeShape
57//! IndexedMapOfOrientedShape
58//! DataMapOfShapeSequenceOfShape
59//! IndexedDataMapOfShapeAddress
60//! DataMapOfOrientedShapeShape
61//!
62//! * LocationSet : to write sets of locations.
63//!
64//! * ShapeSet : to writes sets of TShapes.
65//!
66//! Package Methods :
67//!
68//! Dump : To dump the topology of a Shape.
69class TopTools
70{
71public:
72
73 DEFINE_STANDARD_ALLOC
74
75
76 //! A set of Shapes. Can be dump, wrote or read.
77 //! Dumps the topological structure of <Sh> on the
78 //! stream <S>.
79 Standard_EXPORT static void Dump (const TopoDS_Shape& Sh, Standard_OStream& S);
80
81 //! This is to bypass an extraction bug. It will force
82 //! the inclusion of Standard_Integer.hxx itself
83 //! including Standard_OStream.hxx at the correct
84 //! position.
85 Standard_EXPORT static void Dummy (const Standard_Integer I);
86
42cf5bc1 87};
88
42cf5bc1 89#endif // _TopTools_HeaderFile