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