include/opencascade/IGESDimen_GeneralSymbol.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen (Anand NATRAJAN)
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_GeneralSymbol_HeaderFile
0018 #define _IGESDimen_GeneralSymbol_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <IGESData_IGESEntity.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 #include <IGESDimen_LeaderArrow.hxx>
0027 #include <Standard_Integer.hxx>
0028 class IGESDimen_GeneralNote;
0029 class IGESDimen_LeaderArrow;
0030
0031 //! defines General Symbol, Type <228>, Form <0-3,5001-9999>
0032 //! in package IGESDimen
0033 //! Consists of zero or one (Form 0) or one (all other
0034 //! forms), one or more geometry entities which define
0035 //! a symbol, and zero, one or more associated leaders.
0036 class IGESDimen_GeneralSymbol : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040   Standard_EXPORT IGESDimen_GeneralSymbol();
0041
0042   //! This method is used to set the fields of the class
0043   //! GeneralSymbol
0044   //! - aNote      : General Note, null for form 0
0045   //! - allGeoms   : Geometric Entities
0046   //! - allLeaders : Leader Arrows
0047   Standard_EXPORT void Init(
0048     const occ::handle<IGESDimen_GeneralNote>&                                   aNote,
0049     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>&   allGeoms,
0050     const occ::handle<NCollection_HArray1<occ::handle<IGESDimen_LeaderArrow>>>& allLeaders);
0051
0052   //! Changes FormNumber (indicates the Nature of the Symbol)
0053   //! Error if not in ranges [0-3] or [> 5000]
0054   Standard_EXPORT void SetFormNumber(const int form);
0055
0056   //! returns True if there is associated General Note Entity
0057   Standard_EXPORT bool HasNote() const;
0058
0059   //! returns Null handle for form 0 only
0060   Standard_EXPORT occ::handle<IGESDimen_GeneralNote> Note() const;
0061
0062   //! returns number of Geometry Entities
0063   Standard_EXPORT int NbGeomEntities() const;
0064
0065   //! returns the Index'th Geometry Entity
0066   //! raises exception if Index <= 0 or Index > NbGeomEntities()
0067   Standard_EXPORT occ::handle<IGESData_IGESEntity> GeomEntity(const int Index) const;
0068
0069   //! returns number of Leaders or zero if not specified
0070   Standard_EXPORT int NbLeaders() const;
0071
0072   //! returns the Index'th Leader Arrow
0073   //! raises exception if Index <= 0 or Index > NbLeaders()
0074   Standard_EXPORT occ::handle<IGESDimen_LeaderArrow> LeaderArrow(const int Index) const;
0075
0076   DEFINE_STANDARD_RTTIEXT(IGESDimen_GeneralSymbol, IGESData_IGESEntity)
0077
0078 private:
0079   occ::handle<IGESDimen_GeneralNote>                                   theNote;
0080   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>   theGeoms;
0081   occ::handle<NCollection_HArray1<occ::handle<IGESDimen_LeaderArrow>>> theLeaders;
0082 };
0083
0084 #endif // _IGESDimen_GeneralSymbol_HeaderFile