include/opencascade/IGESDefs_AssociativityDef.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 _IGESDefs_AssociativityDef_HeaderFile
0018 #define _IGESDefs_AssociativityDef_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <TColStd_HArray1OfInteger.hxx>
0024 #include <IGESData_IGESEntity.hxx>
0025 #include <Standard_Integer.hxx>
0026 class IGESBasic_HArray1OfHArray1OfInteger;
0027
0028
0029 class IGESDefs_AssociativityDef;
0030 DEFINE_STANDARD_HANDLE(IGESDefs_AssociativityDef, IGESData_IGESEntity)
0031
0032 //! defines IGES Associativity Definition Entity, Type <302>
0033 //! Form <5001 - 9999> in package IGESDefs.
0034 //! This class permits the preprocessor to define an
0035 //! associativity schema. i.e., by using it preprocessor
0036 //! defines the type of relationship.
0037 class IGESDefs_AssociativityDef : public IGESData_IGESEntity
0038 {
0039
0040 public:
0041
0042
0043   Standard_EXPORT IGESDefs_AssociativityDef();
0044
0045   //! This method is used to set the fields of the class
0046   //! AssociativityDef
0047   //! - requirements : Back Pointers requirements
0048   //! - orders       : Class Orders
0049   //! - numItems     : Number of Items per Class
0050   //! - items        : Items in each class
0051   //! raises exception if lengths of the arrays are not the same.
0052   Standard_EXPORT void Init (const Handle(TColStd_HArray1OfInteger)& requirements, const Handle(TColStd_HArray1OfInteger)& orders, const Handle(TColStd_HArray1OfInteger)& numItems, const Handle(IGESBasic_HArray1OfHArray1OfInteger)& items);
0053
0054   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
0055
0056   //! returns the Number of class definitions
0057   Standard_EXPORT Standard_Integer NbClassDefs() const;
0058
0059   //! returns 1 if the theBackPointerReqs(ClassNum) = 1
0060   //! returns 0 if the theBackPointerReqs(ClassNum) = 2
0061   //! raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()
0062   Standard_EXPORT Standard_Boolean IsBackPointerReq (const Standard_Integer ClassNum) const;
0063
0064   //! returns 1 or 2
0065   //! raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()
0066   Standard_EXPORT Standard_Integer BackPointerReq (const Standard_Integer ClassNum) const;
0067
0068   //! returns 1 if theClassOrders(ClassNum) = 1 (ordered class)
0069   //! returns 0 if theClassOrders(ClassNum) = 2 (unordered class)
0070   //! raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()
0071   Standard_EXPORT Standard_Boolean IsOrdered (const Standard_Integer ClassNum) const;
0072
0073   //! returns 1 or 2
0074   //! raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()
0075   Standard_EXPORT Standard_Integer ClassOrder (const Standard_Integer ClassNum) const;
0076
0077   //! returns no. of items per class entry
0078   //! raises exception if ClassNum <= 0 or ClassNum > NbClassDefs()
0079   Standard_EXPORT Standard_Integer NbItemsPerClass (const Standard_Integer ClassNum) const;
0080
0081   //! returns ItemNum'th Item of ClassNum'th Class
0082   //! raises exception if
0083   //! ClassNum <= 0 or ClassNum > NbClassDefs()
0084   //! ItemNum <= 0 or ItemNum > NbItemsPerClass(ClassNum)
0085   Standard_EXPORT Standard_Integer Item (const Standard_Integer ClassNum, const Standard_Integer ItemNum) const;
0086
0087
0088
0089
0090   DEFINE_STANDARD_RTTIEXT(IGESDefs_AssociativityDef,IGESData_IGESEntity)
0091
0092 protected:
0093
0094
0095
0096
0097 private:
0098
0099
0100   Handle(TColStd_HArray1OfInteger) theBackPointerReqs;
0101   Handle(TColStd_HArray1OfInteger) theClassOrders;
0102   Handle(TColStd_HArray1OfInteger) theNbItemsPerClass;
0103   Handle(IGESBasic_HArray1OfHArray1OfInteger) theItems;
0104
0105
0106 };
0107
0108
0109
0110
0111
0112
0113
0114 #endif // _IGESDefs_AssociativityDef_HeaderFile