include/opencascade/TDataXtd_Axis.hxx

0001 // Created on: 2009-04-06
0002 // Created by: Sergey ZARITCHNY
0003 // Copyright (c) 2009-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 _TDataXtd_Axis_HeaderFile
0017 #define _TDataXtd_Axis_HeaderFile
0018
0019 #include <TDataStd_GenericEmpty.hxx>
0020 class TDF_Label;
0021 class gp_Lin;
0022
0023 class TDataXtd_Axis;
0024 DEFINE_STANDARD_HANDLE(TDataXtd_Axis, TDataStd_GenericEmpty)
0025
0026 //! The basis to define an axis attribute.
0027 //!
0028 //! Warning: Use TDataXtd_Geometry  attribute  to retrieve  the
0029 //! gp_Lin of the Axis attribute
0030 class TDataXtd_Axis : public TDataStd_GenericEmpty
0031 {
0032
0033 public:
0034   //! class methods
0035   //! =============
0036   //! Returns the GUID for an axis.
0037   Standard_EXPORT static const Standard_GUID& GetID();
0038
0039   //! Finds or creates an axis attribute defined by the  label.
0040   //! In the case of a creation of an axis, a compatible
0041   //! named shape should already be associated with label.
0042   //! Exceptions
0043   //! Standard_NullObject if no compatible named
0044   //! shape is associated with the label.
0045   Standard_EXPORT static Handle(TDataXtd_Axis) Set(const TDF_Label& label);
0046
0047   //! Find,  or create,  an Axis  attribute  and set <P>  as
0048   //! generated in the associated NamedShape.
0049   //! Axis methods
0050   //! ============
0051   Standard_EXPORT static Handle(TDataXtd_Axis) Set(const TDF_Label& label, const gp_Lin& L);
0052
0053   Standard_EXPORT TDataXtd_Axis();
0054
0055   Standard_EXPORT const Standard_GUID& ID() const Standard_OVERRIDE;
0056
0057   Standard_EXPORT virtual Standard_OStream& Dump(Standard_OStream& anOS) const Standard_OVERRIDE;
0058
0059   DEFINE_DERIVED_ATTRIBUTE(TDataXtd_Axis, TDataStd_GenericEmpty)
0060
0061 protected:
0062 private:
0063 };
0064
0065 #endif // _TDataXtd_Axis_HeaderFile