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_HArray1OfIGESEntity.hxx>
0023 #include <IGESSolid_HArray1OfVertexList.hxx>
0024 #include <TColStd_HArray1OfInteger.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 #include <Standard_Integer.hxx>
0027 class IGESSolid_VertexList;
0028
0029
0030 class IGESSolid_EdgeList;
0031 DEFINE_STANDARD_HANDLE(IGESSolid_EdgeList, IGESData_IGESEntity)
0032
0033 //! defines EdgeList, Type <504> Form <1>
0034 //! in package IGESSolid
0035 //! EdgeList is defined as a segment joining two vertices
0036 //! It contains one or more edge tuples.
0037 class IGESSolid_EdgeList : public IGESData_IGESEntity
0038 {
0039
0040 public:
0041
0042
0043   Standard_EXPORT IGESSolid_EdgeList();
0044
0045   //! This method is used to set the fields of the class
0046   //! EdgeList
0047   //! - curves           : the model space curves
0048   //! - startVertexList  : the vertex list that contains the
0049   //! start vertices
0050   //! - startVertexIndex : the index of the vertex in the
0051   //! corresponding vertex list
0052   //! - endVertexList    : the vertex list that contains the
0053   //! end vertices
0054   //! - endVertexIndex   : the index of the vertex in the
0055   //! corresponding vertex list
0056   //! raises exception if size of curves,startVertexList,startVertexIndex,
0057   //! endVertexList and endVertexIndex do no match
0058   Standard_EXPORT void Init (const Handle(IGESData_HArray1OfIGESEntity)& curves, const Handle(IGESSolid_HArray1OfVertexList)& startVertexList, const Handle(TColStd_HArray1OfInteger)& startVertexIndex, const Handle(IGESSolid_HArray1OfVertexList)& endVertexList, const Handle(TColStd_HArray1OfInteger)& endVertexIndex);
0059
0060   //! returns the number of edges in the edge list
0061   Standard_EXPORT Standard_Integer NbEdges() const;
0062
0063   //! returns the num'th model space curve
0064   //! raises Exception if num <= 0 or num > NbEdges()
0065   Standard_EXPORT Handle(IGESData_IGESEntity) Curve (const Standard_Integer num) const;
0066
0067   //! returns the num'th start vertex list
0068   //! raises Exception if num <= 0 or num > NbEdges()
0069   Standard_EXPORT Handle(IGESSolid_VertexList) StartVertexList (const Standard_Integer num) const;
0070
0071   //! returns the index of num'th start vertex in
0072   //! the corresponding start vertex list
0073   //! raises Exception if num <= 0 or num > NbEdges()
0074   Standard_EXPORT Standard_Integer StartVertexIndex (const Standard_Integer num) const;
0075
0076   //! returns the num'th end vertex list
0077   //! raises Exception if num <= 0 or num > NbEdges()
0078   Standard_EXPORT Handle(IGESSolid_VertexList) EndVertexList (const Standard_Integer num) const;
0079
0080   //! returns the index of num'th end vertex in
0081   //! the corresponding end vertex list
0082   //! raises Exception if num <= 0 or num > NbEdges()
0083   Standard_EXPORT Standard_Integer EndVertexIndex (const Standard_Integer num) const;
0084
0085
0086
0087
0088   DEFINE_STANDARD_RTTIEXT(IGESSolid_EdgeList,IGESData_IGESEntity)
0089
0090 protected:
0091
0092
0093
0094
0095 private:
0096
0097
0098   Handle(IGESData_HArray1OfIGESEntity) theCurves;
0099   Handle(IGESSolid_HArray1OfVertexList) theStartVertexList;
0100   Handle(TColStd_HArray1OfInteger) theStartVertexIndex;
0101   Handle(IGESSolid_HArray1OfVertexList) theEndVertexList;
0102   Handle(TColStd_HArray1OfInteger) theEndVertexIndex;
0103
0104
0105 };
0106
0107
0108
0109
0110
0111
0112
0113 #endif // _IGESSolid_EdgeList_HeaderFile