include/opencascade/IGESSolid_EdgeList.hxx

0001 // Created on: 1993-01-09
0002 // Created by: CKY / Contract Toubro-Larsen ( SIVA )
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 _IGESSolid_EdgeList_HeaderFile
0018 #define _IGESSolid_EdgeList_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESData_IGESEntity.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <IGESSolid_VertexList.hxx>
0026 #include <Standard_Integer.hxx>
0027 class IGESSolid_VertexList;
0028
0029 //! defines EdgeList, Type <504> Form <1>
0030 //! in package IGESSolid
0031 //! EdgeList is defined as a segment joining two vertices
0032 //! It contains one or more edge tuples.
0033 class IGESSolid_EdgeList : public IGESData_IGESEntity
0034 {
0035
0036 public:
0037   Standard_EXPORT IGESSolid_EdgeList();
0038
0039   //! This method is used to set the fields of the class
0040   //! EdgeList
0041   //! - curves           : the model space curves
0042   //! - startVertexList  : the vertex list that contains the
0043   //! start vertices
0044   //! - startVertexIndex : the index of the vertex in the
0045   //! corresponding vertex list
0046   //! - endVertexList    : the vertex list that contains the
0047   //! end vertices
0048   //! - endVertexIndex   : the index of the vertex in the
0049   //! corresponding vertex list
0050   //! raises exception if size of curves,startVertexList,startVertexIndex,
0051   //! endVertexList and endVertexIndex do no match
0052   Standard_EXPORT void Init(
0053     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>&  curves,
0054     const occ::handle<NCollection_HArray1<occ::handle<IGESSolid_VertexList>>>& startVertexList,
0055     const occ::handle<NCollection_HArray1<int>>&                               startVertexIndex,
0056     const occ::handle<NCollection_HArray1<occ::handle<IGESSolid_VertexList>>>& endVertexList,
0057     const occ::handle<NCollection_HArray1<int>>&                               endVertexIndex);
0058
0059   //! returns the number of edges in the edge list
0060   Standard_EXPORT int NbEdges() const;
0061
0062   //! returns the num'th model space curve
0063   //! raises Exception if num <= 0 or num > NbEdges()
0064   Standard_EXPORT occ::handle<IGESData_IGESEntity> Curve(const int num) const;
0065
0066   //! returns the num'th start vertex list
0067   //! raises Exception if num <= 0 or num > NbEdges()
0068   Standard_EXPORT occ::handle<IGESSolid_VertexList> StartVertexList(const int num) const;
0069
0070   //! returns the index of num'th start vertex in
0071   //! the corresponding start vertex list
0072   //! raises Exception if num <= 0 or num > NbEdges()
0073   Standard_EXPORT int StartVertexIndex(const int num) const;
0074
0075   //! returns the num'th end vertex list
0076   //! raises Exception if num <= 0 or num > NbEdges()
0077   Standard_EXPORT occ::handle<IGESSolid_VertexList> EndVertexList(const int num) const;
0078
0079   //! returns the index of num'th end vertex in
0080   //! the corresponding end vertex list
0081   //! raises Exception if num <= 0 or num > NbEdges()
0082   Standard_EXPORT int EndVertexIndex(const int num) const;
0083
0084   DEFINE_STANDARD_RTTIEXT(IGESSolid_EdgeList, IGESData_IGESEntity)
0085
0086 private:
0087   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>  theCurves;
0088   occ::handle<NCollection_HArray1<occ::handle<IGESSolid_VertexList>>> theStartVertexList;
0089   occ::handle<NCollection_HArray1<int>>                               theStartVertexIndex;
0090   occ::handle<NCollection_HArray1<occ::handle<IGESSolid_VertexList>>> theEndVertexList;
0091   occ::handle<NCollection_HArray1<int>>                               theEndVertexIndex;
0092 };
0093
0094 #endif // _IGESSolid_EdgeList_HeaderFile