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
0030 class IGESDimen_LinearDimension;
0031 DEFINE_STANDARD_HANDLE(IGESDimen_LinearDimension, IGESData_IGESEntity)
0032
0033 //! defines LinearDimension, Type <216> Form <0>
0034 //! in package IGESDimen
0035 //! Used for linear dimensioning
0036 class IGESDimen_LinearDimension : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040
0041
0042   Standard_EXPORT IGESDimen_LinearDimension();
0043
0044   //! This method is used to set the fields of the class
0045   //! LinearDimension
0046   //! - aNote          : General Note Entity
0047   //! - aLeader        : First Leader Entity
0048   //! - anotherLeader  : Second Leader Entity
0049   //! - aWitness       : First Witness Line Entity or a Null
0050   //! Handle
0051   //! - anotherWitness : Second Witness Line Entity or a Null
0052   //! Handle
0053   Standard_EXPORT void Init (const Handle(IGESDimen_GeneralNote)& aNote, const Handle(IGESDimen_LeaderArrow)& aLeader, const Handle(IGESDimen_LeaderArrow)& anotherLeader, const Handle(IGESDimen_WitnessLine)& aWitness, const Handle(IGESDimen_WitnessLine)& anotherWitness);
0054
0055   //! Changes FormNumber (indicates the Nature of the Dimension
0056   //! Unspecified, Diameter or Radius)
0057   //! Error if not in range [0-2]
0058   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
0059
0060   //! returns General Note Entity
0061   Standard_EXPORT Handle(IGESDimen_GeneralNote) Note() const;
0062
0063   //! returns first Leader Entity
0064   Standard_EXPORT Handle(IGESDimen_LeaderArrow) FirstLeader() const;
0065
0066   //! returns second Leader Entity
0067   Standard_EXPORT Handle(IGESDimen_LeaderArrow) SecondLeader() const;
0068
0069   //! returns False if no first witness line
0070   Standard_EXPORT Standard_Boolean HasFirstWitness() const;
0071
0072   //! returns first Witness Line Entity or a Null Handle
0073   Standard_EXPORT Handle(IGESDimen_WitnessLine) FirstWitness() const;
0074
0075   //! returns False if no second witness line
0076   Standard_EXPORT Standard_Boolean HasSecondWitness() const;
0077
0078   //! returns second Witness Line Entity or a Null Handle
0079   Standard_EXPORT Handle(IGESDimen_WitnessLine) SecondWitness() const;
0080
0081
0082
0083
0084   DEFINE_STANDARD_RTTIEXT(IGESDimen_LinearDimension,IGESData_IGESEntity)
0085
0086 protected:
0087
0088
0089
0090
0091 private:
0092
0093
0094   Handle(IGESDimen_GeneralNote) theNote;
0095   Handle(IGESDimen_LeaderArrow) theFirstLeader;
0096   Handle(IGESDimen_LeaderArrow) theSecondLeader;
0097   Handle(IGESDimen_WitnessLine) theFirstWitness;
0098   Handle(IGESDimen_WitnessLine) theSecondWitness;
0099
0100
0101 };
0102
0103
0104
0105
0106
0107
0108
0109 #endif // _IGESDimen_LinearDimension_HeaderFile