include/opencascade/IGESDimen_LinearDimension.hxx

0001 // Created on: 1993-01-13
0002 // Created by: CKY / Contract Toubro-Larsen ( Deepak PRABHU )
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_LinearDimension_HeaderFile
0018 #define _IGESDimen_LinearDimension_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESData_IGESEntity.hxx>
0024 #include <Standard_Integer.hxx>
0025 class IGESDimen_GeneralNote;
0026 class IGESDimen_LeaderArrow;
0027 class IGESDimen_WitnessLine;
0028
0029 //! defines LinearDimension, Type <216> Form <0>
0030 //! in package IGESDimen
0031 //! Used for linear dimensioning
0032 class IGESDimen_LinearDimension : public IGESData_IGESEntity
0033 {
0034
0035 public:
0036   Standard_EXPORT IGESDimen_LinearDimension();
0037
0038   //! This method is used to set the fields of the class
0039   //! LinearDimension
0040   //! - aNote          : General Note Entity
0041   //! - aLeader        : First Leader Entity
0042   //! - anotherLeader  : Second Leader Entity
0043   //! - aWitness       : First Witness Line Entity or a Null
0044   //! Handle
0045   //! - anotherWitness : Second Witness Line Entity or a Null
0046   //! Handle
0047   Standard_EXPORT void Init(const occ::handle<IGESDimen_GeneralNote>& aNote,
0048                             const occ::handle<IGESDimen_LeaderArrow>& aLeader,
0049                             const occ::handle<IGESDimen_LeaderArrow>& anotherLeader,
0050                             const occ::handle<IGESDimen_WitnessLine>& aWitness,
0051                             const occ::handle<IGESDimen_WitnessLine>& anotherWitness);
0052
0053   //! Changes FormNumber (indicates the Nature of the Dimension
0054   //! Unspecified, Diameter or Radius)
0055   //! Error if not in range [0-2]
0056   Standard_EXPORT void SetFormNumber(const int form);
0057
0058   //! returns General Note Entity
0059   Standard_EXPORT occ::handle<IGESDimen_GeneralNote> Note() const;
0060
0061   //! returns first Leader Entity
0062   Standard_EXPORT occ::handle<IGESDimen_LeaderArrow> FirstLeader() const;
0063
0064   //! returns second Leader Entity
0065   Standard_EXPORT occ::handle<IGESDimen_LeaderArrow> SecondLeader() const;
0066
0067   //! returns False if no first witness line
0068   Standard_EXPORT bool HasFirstWitness() const;
0069
0070   //! returns first Witness Line Entity or a Null Handle
0071   Standard_EXPORT occ::handle<IGESDimen_WitnessLine> FirstWitness() const;
0072
0073   //! returns False if no second witness line
0074   Standard_EXPORT bool HasSecondWitness() const;
0075
0076   //! returns second Witness Line Entity or a Null Handle
0077   Standard_EXPORT occ::handle<IGESDimen_WitnessLine> SecondWitness() const;
0078
0079   DEFINE_STANDARD_RTTIEXT(IGESDimen_LinearDimension, IGESData_IGESEntity)
0080
0081 private:
0082   occ::handle<IGESDimen_GeneralNote> theNote;
0083   occ::handle<IGESDimen_LeaderArrow> theFirstLeader;
0084   occ::handle<IGESDimen_LeaderArrow> theSecondLeader;
0085   occ::handle<IGESDimen_WitnessLine> theFirstWitness;
0086   occ::handle<IGESDimen_WitnessLine> theSecondWitness;
0087 };
0088
0089 #endif // _IGESDimen_LinearDimension_HeaderFile