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_HArray1OfIGESEntity.hxx>
0024 #include <IGESDimen_HArray1OfLeaderArrow.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class IGESDimen_GeneralNote;
0028 class IGESDimen_LeaderArrow;
0029
0030
0031 class IGESDimen_GeneralSymbol;
0032 DEFINE_STANDARD_HANDLE(IGESDimen_GeneralSymbol, IGESData_IGESEntity)
0033
0034 //! defines General Symbol, Type <228>, Form <0-3,5001-9999>
0035 //! in package IGESDimen
0036 //! Consists of zero or one (Form 0) or one (all other
0037 //! forms), one or more geometry entities which define
0038 //! a symbol, and zero, one or more associated leaders.
0039 class IGESDimen_GeneralSymbol : public IGESData_IGESEntity
0040 {
0041
0042 public:
0043
0044
0045   Standard_EXPORT IGESDimen_GeneralSymbol();
0046
0047   //! This method is used to set the fields of the class
0048   //! GeneralSymbol
0049   //! - aNote      : General Note, null for form 0
0050   //! - allGeoms   : Geometric Entities
0051   //! - allLeaders : Leader Arrows
0052   Standard_EXPORT void Init (const Handle(IGESDimen_GeneralNote)& aNote, const Handle(IGESData_HArray1OfIGESEntity)& allGeoms, const Handle(IGESDimen_HArray1OfLeaderArrow)& allLeaders);
0053
0054   //! Changes FormNumber (indicates the Nature of the Symbole)
0055   //! Error if not in ranges [0-3] or [> 5000]
0056   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
0057
0058   //! returns True if there is associated General Note Entity
0059   Standard_EXPORT Standard_Boolean HasNote() const;
0060
0061   //! returns Null handle for form 0 only
0062   Standard_EXPORT Handle(IGESDimen_GeneralNote) Note() const;
0063
0064   //! returns number of Geometry Entities
0065   Standard_EXPORT Standard_Integer NbGeomEntities() const;
0066
0067   //! returns the Index'th Geometry Entity
0068   //! raises exception if Index <= 0 or Index > NbGeomEntities()
0069   Standard_EXPORT Handle(IGESData_IGESEntity) GeomEntity (const Standard_Integer Index) const;
0070
0071   //! returns number of Leaders or zero if not specified
0072   Standard_EXPORT Standard_Integer NbLeaders() const;
0073
0074   //! returns the Index'th Leader Arrow
0075   //! raises exception if Index <= 0 or Index > NbLeaders()
0076   Standard_EXPORT Handle(IGESDimen_LeaderArrow) LeaderArrow (const Standard_Integer Index) const;
0077
0078
0079
0080
0081   DEFINE_STANDARD_RTTIEXT(IGESDimen_GeneralSymbol,IGESData_IGESEntity)
0082
0083 protected:
0084
0085
0086
0087
0088 private:
0089
0090
0091   Handle(IGESDimen_GeneralNote) theNote;
0092   Handle(IGESData_HArray1OfIGESEntity) theGeoms;
0093   Handle(IGESDimen_HArray1OfLeaderArrow) theLeaders;
0094
0095
0096 };
0097
0098
0099
0100
0101
0102
0103
0104 #endif // _IGESDimen_GeneralSymbol_HeaderFile