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 //! attribute to store area
0029 class XCAFDoc_Area : public TDataStd_Real
0030 {
0031
0032 public:
0033   //! class methods
0034   //! =============
0035   Standard_EXPORT XCAFDoc_Area();
0036
0037   Standard_EXPORT static const Standard_GUID& GetID();
0038
0039   Standard_EXPORT const Standard_GUID& ID() const override;
0040
0041   //! Sets a value of volume
0042   Standard_EXPORT void Set(const double vol);
0043
0044   //! Find, or create, an Area attribute and set its value
0045   Standard_EXPORT static occ::handle<XCAFDoc_Area> Set(const TDF_Label& label, const double area);
0046
0047   Standard_EXPORT double Get() const;
0048
0049   //! Returns volume of area as argument and success status
0050   //! returns false if no such attribute at the <label>
0051   Standard_EXPORT static bool Get(const TDF_Label& label, double& area);
0052
0053   Standard_EXPORT Standard_OStream& Dump(Standard_OStream& anOS) const override;
0054
0055   //! Dumps the content of me into the stream
0056   Standard_EXPORT void DumpJson(Standard_OStream& theOStream, int theDepth = -1) const override;
0057
0058   DEFINE_DERIVED_ATTRIBUTE(XCAFDoc_Area, TDataStd_Real)
0059 };
0060
0061 #endif // _XCAFDoc_Area_HeaderFile