include/opencascade/XCAFDoc_Area.hxx

0001 // Created on: 2000-09-08
0002 // Created by: data exchange team
0003 // Copyright (c) 2000-2014 OPEN CASCADE SAS
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _XCAFDoc_Area_HeaderFile
0017 #define _XCAFDoc_Area_HeaderFile
0018
0019 #include <Standard.hxx>
0020 #include <Standard_Type.hxx>
0021
0022 #include <Standard_Real.hxx>
0023 #include <TDataStd_Real.hxx>
0024 #include <Standard_OStream.hxx>
0025 class Standard_GUID;
0026 class TDF_Label;
0027
0028
0029 class XCAFDoc_Area;
0030 DEFINE_STANDARD_HANDLE(XCAFDoc_Area, TDataStd_Real)
0031
0032 //! attribute to store area
0033 class XCAFDoc_Area : public TDataStd_Real
0034 {
0035
0036 public:
0037
0038
0039   //! class methods
0040   //! =============
0041   Standard_EXPORT XCAFDoc_Area();
0042
0043   Standard_EXPORT static const Standard_GUID& GetID();
0044
0045   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0046
0047   //! Sets a value of volume
0048   Standard_EXPORT void Set (const Standard_Real vol);
0049
0050   //! Find, or create, an Area attribute and set its value
0051   Standard_EXPORT static Handle(XCAFDoc_Area) Set (const TDF_Label& label, const Standard_Real area);
0052
0053   Standard_EXPORT Standard_Real Get() const;
0054
0055   //! Returns volume of area as argument and success status
0056   //! returns false if no such attribute at the <label>
0057   Standard_EXPORT static Standard_Boolean Get (const TDF_Label& label, Standard_Real& area);
0058
0059   Standard_EXPORT virtual Standard_OStream& Dump (Standard_OStream& anOS) const Standard_OVERRIDE;
0060
0061   //! Dumps the content of me into the stream
0062   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
0063
0064
0065   DEFINE_DERIVED_ATTRIBUTE(XCAFDoc_Area,TDataStd_Real)
0066
0067 };
0068
0069
0070
0071
0072
0073
0074
0075 #endif // _XCAFDoc_Area_HeaderFile