include/opencascade/IGESAppli_NodalDisplAndRot.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Arun MENON )
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 _IGESAppli_NodalDisplAndRot_HeaderFile
0018 #define _IGESAppli_NodalDisplAndRot_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <IGESDimen_GeneralNote.hxx>
0023 #include <NCollection_Array1.hxx>
0024 #include <NCollection_HArray1.hxx>
0025 #include <Standard_Integer.hxx>
0026 #include <IGESAppli_Node.hxx>
0027 #include <IGESData_IGESEntity.hxx>
0028 class IGESBasic_HArray1OfHArray1OfXYZ;
0029 class IGESDimen_GeneralNote;
0030 class IGESAppli_Node;
0031 class gp_XYZ;
0032
0033 //! defines NodalDisplAndRot, Type <138> Form <0>
0034 //! in package IGESAppli
0035 //! Used to communicate finite element post processing
0036 //! data.
0037 class IGESAppli_NodalDisplAndRot : public IGESData_IGESEntity
0038 {
0039
0040 public:
0041   Standard_EXPORT IGESAppli_NodalDisplAndRot();
0042
0043   //! This method is used to set the fields of the class
0044   //! NodalDisplAndRot
0045   //! - allNotes       : Used to store the general note describing
0046   //! the analysis cases
0047   //! - allIdentifiers : Used to store the node number
0048   //! identifier for the nodes
0049   //! - allNodes       : Used to store the nodes
0050   //! - allRotParams   : Used to store the rotation for the nodes
0051   //! - allTransParams : Used to store the incremental
0052   //! displacements for the nodes
0053   //! raises exception if Lengths of allIdentifiers, allNodes,
0054   //! allRotParams, and allTransParams are not same
0055   //! or if length of allNotes and size of each element of allRotParams
0056   //! and allTransParam are not same
0057   Standard_EXPORT void Init(
0058     const occ::handle<NCollection_HArray1<occ::handle<IGESDimen_GeneralNote>>>& allNotes,
0059     const occ::handle<NCollection_HArray1<int>>&                                allIdentifiers,
0060     const occ::handle<NCollection_HArray1<occ::handle<IGESAppli_Node>>>&        allNodes,
0061     const occ::handle<IGESBasic_HArray1OfHArray1OfXYZ>&                         allRotParams,
0062     const occ::handle<IGESBasic_HArray1OfHArray1OfXYZ>&                         allTransParams);
0063
0064   //! returns the number of analysis cases
0065   Standard_EXPORT int NbCases() const;
0066
0067   //! returns the number of nodes
0068   Standard_EXPORT int NbNodes() const;
0069
0070   //! returns the General Note that describes the Index analysis case
0071   //! raises exception if Index <= 0 or Index > NbCases
0072   Standard_EXPORT occ::handle<IGESDimen_GeneralNote> Note(const int Index) const;
0073
0074   //! returns the node identifier as specified by the Index
0075   //! raises exception if Index <= 0 or Index > NbNodes
0076   Standard_EXPORT int NodeIdentifier(const int Index) const;
0077
0078   //! returns the node as specified by the Index
0079   //! raises exception if Index <= 0 or Index > NbNodes
0080   Standard_EXPORT occ::handle<IGESAppli_Node> Node(const int Index) const;
0081
0082   //! returns the Translational Parameters for the particular Index
0083   //! Exception raised if NodeNum <= 0 or NodeNum > NbNodes()
0084   //! or CaseNum <= 0 or CaseNum > NbCases()
0085   Standard_EXPORT gp_XYZ TranslationParameter(const int NodeNum, const int CaseNum) const;
0086
0087   //! returns the Rotational Parameters for Index
0088   //! Exception raised if NodeNum <= 0 or NodeNum > NbNodes()
0089   //! or CaseNum <= 0 or CaseNum > NbCases()
0090   Standard_EXPORT gp_XYZ RotationalParameter(const int NodeNum, const int CaseNum) const;
0091
0092   DEFINE_STANDARD_RTTIEXT(IGESAppli_NodalDisplAndRot, IGESData_IGESEntity)
0093
0094 private:
0095   occ::handle<NCollection_HArray1<occ::handle<IGESDimen_GeneralNote>>> theNotes;
0096   occ::handle<NCollection_HArray1<int>>                                theNodeIdentifiers;
0097   occ::handle<NCollection_HArray1<occ::handle<IGESAppli_Node>>>        theNodes;
0098   occ::handle<IGESBasic_HArray1OfHArray1OfXYZ>                         theTransParam;
0099   occ::handle<IGESBasic_HArray1OfHArray1OfXYZ>                         theRotParam;
0100 };
0101
0102 #endif // _IGESAppli_NodalDisplAndRot_HeaderFile