0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / TopLoc / TopLoc_ItemLocation.hxx
1 // Created on: 1991-01-21
2 // Created by: Christophe MARION
3 // Copyright (c) 1991-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 _TopLoc_ItemLocation_HeaderFile
18 #define _TopLoc_ItemLocation_HeaderFile
19
20 #include <Standard.hxx>
21 #include <Standard_DefineAlloc.hxx>
22 #include <Standard_Handle.hxx>
23
24 #include <Standard_Integer.hxx>
25 #include <Standard_OStream.hxx>
26 #include <gp_Trsf.hxx>
27 class TopLoc_Datum3D;
28 class TopLoc_Location;
29 class TopLoc_SListOfItemLocation;
30
31
32 //! An ItemLocation is an elementary coordinate system
33 //! in a Location.
34 //!
35 //! The  ItemLocation     contains :
36 //!
37 //! * The elementary Datum.
38 //!
39 //! * The exponent of the elementary Datum.
40 //!
41 //! * The transformation associated to the composition.
42 class TopLoc_ItemLocation 
43 {
44 public:
45
46   DEFINE_STANDARD_ALLOC
47
48   
49   //! Sets the elementary Datum to <D>
50   //! Sets the exponent to <P>
51   Standard_EXPORT TopLoc_ItemLocation(const Handle(TopLoc_Datum3D)& D, const Standard_Integer P);
52
53   //! Dumps the content of me into the stream
54   Standard_EXPORT void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
55
56
57 friend class TopLoc_Location;
58 friend class TopLoc_SListOfItemLocation;
59
60
61 protected:
62
63
64
65
66
67 private:
68
69
70
71   Handle(TopLoc_Datum3D) myDatum;
72   Standard_Integer myPower;
73   gp_Trsf myTrsf;
74
75
76 };
77
78
79
80
81
82
83
84 #endif // _TopLoc_ItemLocation_HeaderFile