src/IGESAppli/IGESAppli_NodalDisplAndRot.hxx

   1 // Created on: 1993-01-11
   2 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
   3 // Copyright (c) 1993-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _IGESAppli_NodalDisplAndRot_HeaderFile
  18 #define _IGESAppli_NodalDisplAndRot_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_Type.hxx>
  22
  23 #include <IGESDimen_HArray1OfGeneralNote.hxx>
  24 #include <TColStd_HArray1OfInteger.hxx>
  25 #include <IGESAppli_HArray1OfNode.hxx>
  26 #include <IGESData_IGESEntity.hxx>
  27 #include <Standard_Integer.hxx>
  28 class IGESBasic_HArray1OfHArray1OfXYZ;
  29 class Standard_DimensionMismatch;
  30 class Standard_OutOfRange;
  31 class IGESDimen_GeneralNote;
  32 class IGESAppli_Node;
  33 class gp_XYZ;
  34
  35
  36 class IGESAppli_NodalDisplAndRot;
  37 DEFINE_STANDARD_HANDLE(IGESAppli_NodalDisplAndRot, IGESData_IGESEntity)
  38
  39 //! defines NodalDisplAndRot, Type <138> Form <0>
  40 //! in package IGESAppli
  41 //! Used to communicate finite element post processing
  42 //! data.
  43 class IGESAppli_NodalDisplAndRot : public IGESData_IGESEntity
  44 {
  45
  46 public:
  47
  48
  49   Standard_EXPORT IGESAppli_NodalDisplAndRot();
  50
  51   //! This method is used to set the fields of the class
  52   //! NodalDisplAndRot
  53   //! - allNotes       : Used to store the general note describing
  54   //! the analysis cases
  55   //! - allIdentifiers : Used to store the node number
  56   //! identifier for the nodes
  57   //! - allNodes       : Used to store the nodes
  58   //! - allRotParams   : Used to store the rotation for the nodes
  59   //! - allTransParams : Used to store the incremental
  60   //! displacements for the nodes
  61   //! raises exception if Lengths of allIdentifiers, allNodes,
  62   //! allRotParams, and allTransParams are not same
  63   //! or if length of allNotes and size of each element of allRotParams
  64   //! and allTransParam are not same
  65   Standard_EXPORT void Init (const Handle(IGESDimen_HArray1OfGeneralNote)& allNotes, const Handle(TColStd_HArray1OfInteger)& allIdentifiers, const Handle(IGESAppli_HArray1OfNode)& allNodes, const Handle(IGESBasic_HArray1OfHArray1OfXYZ)& allRotParams, const Handle(IGESBasic_HArray1OfHArray1OfXYZ)& allTransParams);
  66
  67   //! returns the number of analysis cases
  68   Standard_EXPORT Standard_Integer NbCases() const;
  69
  70   //! returns the number of nodes
  71   Standard_EXPORT Standard_Integer NbNodes() const;
  72
  73   //! returns the General Note that describes the Index analysis case
  74   //! raises exception if Index <= 0 or Index > NbCases
  75   Standard_EXPORT Handle(IGESDimen_GeneralNote) Note (const Standard_Integer Index) const;
  76
  77   //! returns the node identifier as specified by the Index
  78   //! raises exception if Index <= 0 or Index > NbNodes
  79   Standard_EXPORT Standard_Integer NodeIdentifier (const Standard_Integer Index) const;
  80
  81   //! returns the node as specified by the Index
  82   //! raises exception if Index <= 0 or Index > NbNodes
  83   Standard_EXPORT Handle(IGESAppli_Node) Node (const Standard_Integer Index) const;
  84
  85   //! returns the Translational Parameters for the particular Index
  86   //! Exception raised if NodeNum <= 0 or NodeNum > NbNodes()
  87   //! or CaseNum <= 0 or CaseNum > NbCases()
  88   Standard_EXPORT gp_XYZ TranslationParameter (const Standard_Integer NodeNum, const Standard_Integer CaseNum) const;
  89
  90   //! returns the Rotational Parameters for Index
  91   //! Exception raised if NodeNum <= 0 or NodeNum > NbNodes()
  92   //! or CaseNum <= 0 or CaseNum > NbCases()
  93   Standard_EXPORT gp_XYZ RotationalParameter (const Standard_Integer NodeNum, const Standard_Integer CaseNum) const;
  94
  95
  96
  97
  98   DEFINE_STANDARD_RTTIEXT(IGESAppli_NodalDisplAndRot,IGESData_IGESEntity)
  99
 100 protected:
 101
 102
 103
 104
 105 private:
 106
 107
 108   Handle(IGESDimen_HArray1OfGeneralNote) theNotes;
 109   Handle(TColStd_HArray1OfInteger) theNodeIdentifiers;
 110   Handle(IGESAppli_HArray1OfNode) theNodes;
 111   Handle(IGESBasic_HArray1OfHArray1OfXYZ) theTransParam;
 112   Handle(IGESBasic_HArray1OfHArray1OfXYZ) theRotParam;
 113
 114
 115 };
 116
 117
 118
 119
 120
 121
 122
 123 #endif // _IGESAppli_NodalDisplAndRot_HeaderFile