include/opencascade/IGESDimen_GeneralLabel.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_GeneralLabel_HeaderFile
0018 #define _IGESDimen_GeneralLabel_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESDimen_LeaderArrow.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class IGESDimen_GeneralNote;
0028 class IGESDimen_LeaderArrow;
0029
0030 //! defines GeneralLabel, Type <210> Form <0>
0031 //! in package IGESDimen
0032 //! Used for general labeling with leaders
0033 class IGESDimen_GeneralLabel : public IGESData_IGESEntity
0034 {
0035
0036 public:
0037   Standard_EXPORT IGESDimen_GeneralLabel();
0038
0039   //! This method is used to set the fields of the class
0040   //! GeneralLabel
0041   //! - aNote       : General Note Entity
0042   //! - someLeaders : Associated Leader Entities
0043   Standard_EXPORT void Init(
0044     const occ::handle<IGESDimen_GeneralNote>&                                   aNote,
0045     const occ::handle<NCollection_HArray1<occ::handle<IGESDimen_LeaderArrow>>>& someLeaders);
0046
0047   //! returns General Note Entity
0048   Standard_EXPORT occ::handle<IGESDimen_GeneralNote> Note() const;
0049
0050   //! returns Number of Leaders
0051   Standard_EXPORT int NbLeaders() const;
0052
0053   //! returns Leader Entity
0054   //! raises exception if Index <= 0 or Index > NbLeaders()
0055   Standard_EXPORT occ::handle<IGESDimen_LeaderArrow> Leader(const int Index) const;
0056
0057   DEFINE_STANDARD_RTTIEXT(IGESDimen_GeneralLabel, IGESData_IGESEntity)
0058
0059 private:
0060   occ::handle<IGESDimen_GeneralNote>                                   theNote;
0061   occ::handle<NCollection_HArray1<occ::handle<IGESDimen_LeaderArrow>>> theLeaders;
0062 };
0063
0064 #endif // _IGESDimen_GeneralLabel_HeaderFile