include/opencascade/IGESDimen_OrdinateDimension.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _IGESDimen_OrdinateDimension_HeaderFile
0018 #define _IGESDimen_OrdinateDimension_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESData_IGESEntity.hxx>
0024 class IGESDimen_GeneralNote;
0025 class IGESDimen_WitnessLine;
0026 class IGESDimen_LeaderArrow;
0027
0028 //! defines IGES Ordinate Dimension, Type <218> Form <0, 1>,
0029 //! in package IGESDimen
0030 //! Note: The ordinate dimension entity is used to
0031 //! indicate dimensions from a common base line.
0032 //! Dimensioning is only permitted along the XT
0033 //! or YT axis.
0034 class IGESDimen_OrdinateDimension : public IGESData_IGESEntity
0035 {
0036
0037 public:
0038   Standard_EXPORT IGESDimen_OrdinateDimension();
0039
0040   Standard_EXPORT void Init(const occ::handle<IGESDimen_GeneralNote>& aNote,
0041                             const bool                                aType,
0042                             const occ::handle<IGESDimen_WitnessLine>& aLine,
0043                             const occ::handle<IGESDimen_LeaderArrow>& anArrow);
0044
0045   //! returns True if Witness Line and False if Leader (only for Form 0)
0046   Standard_EXPORT bool IsLine() const;
0047
0048   //! returns True if Leader and False if Witness Line (only for Form 0)
0049   Standard_EXPORT bool IsLeader() const;
0050
0051   //! returns the General Note entity associated.
0052   Standard_EXPORT occ::handle<IGESDimen_GeneralNote> Note() const;
0053
0054   //! returns the Witness Line associated or Null handle
0055   Standard_EXPORT occ::handle<IGESDimen_WitnessLine> WitnessLine() const;
0056
0057   //! returns the Leader associated or Null handle
0058   Standard_EXPORT occ::handle<IGESDimen_LeaderArrow> Leader() const;
0059
0060   DEFINE_STANDARD_RTTIEXT(IGESDimen_OrdinateDimension, IGESData_IGESEntity)
0061
0062 private:
0063   occ::handle<IGESDimen_GeneralNote> theNote;
0064   bool                               isItLine;
0065   occ::handle<IGESDimen_WitnessLine> theWitnessLine;
0066   occ::handle<IGESDimen_LeaderArrow> theLeader;
0067 };
0068
0069 #endif // _IGESDimen_OrdinateDimension_HeaderFile