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
0033 class IGESAppli_NodalDisplAndRot;
0034 DEFINE_STANDARD_HANDLE(IGESAppli_NodalDisplAndRot, IGESData_IGESEntity)
0035
0036 //! defines NodalDisplAndRot, Type <138> Form <0>
0037 //! in package IGESAppli
0038 //! Used to communicate finite element post processing
0039 //! data.
0040 class IGESAppli_NodalDisplAndRot : public IGESData_IGESEntity
0041 {
0042
0043 public:
0044
0045
0046   Standard_EXPORT IGESAppli_NodalDisplAndRot();
0047
0048   //! This method is used to set the fields of the class
0049   //! NodalDisplAndRot
0050   //! - allNotes       : Used to store the general note describing
0051   //! the analysis cases
0052   //! - allIdentifiers : Used to store the node number
0053   //! identifier for the nodes
0054   //! - allNodes       : Used to store the nodes
0055   //! - allRotParams   : Used to store the rotation for the nodes
0056   //! - allTransParams : Used to store the incremental
0057   //! displacements for the nodes
0058   //! raises exception if Lengths of allIdentifiers, allNodes,
0059   //! allRotParams, and allTransParams are not same
0060   //! or if length of allNotes and size of each element of allRotParams
0061   //! and allTransParam are not same
0062   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);
0063
0064   //! returns the number of analysis cases
0065   Standard_EXPORT Standard_Integer NbCases() const;
0066
0067   //! returns the number of nodes
0068   Standard_EXPORT Standard_Integer 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 Handle(IGESDimen_GeneralNote) Note (const Standard_Integer 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 Standard_Integer NodeIdentifier (const Standard_Integer Index) const;
0077
0078   //! returns the node as specified by the Index
0079   //! raises exception if Index <= 0 or Index > NbNodes
0080   Standard_EXPORT Handle(IGESAppli_Node) Node (const Standard_Integer 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 Standard_Integer NodeNum, const Standard_Integer 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 Standard_Integer NodeNum, const Standard_Integer CaseNum) const;
0091
0092
0093
0094
0095   DEFINE_STANDARD_RTTIEXT(IGESAppli_NodalDisplAndRot,IGESData_IGESEntity)
0096
0097 protected:
0098
0099
0100
0101
0102 private:
0103
0104
0105   Handle(IGESDimen_HArray1OfGeneralNote) theNotes;
0106   Handle(TColStd_HArray1OfInteger) theNodeIdentifiers;
0107   Handle(IGESAppli_HArray1OfNode) theNodes;
0108   Handle(IGESBasic_HArray1OfHArray1OfXYZ) theTransParam;
0109   Handle(IGESBasic_HArray1OfHArray1OfXYZ) theRotParam;
0110
0111
0112 };
0113
0114
0115
0116
0117
0118
0119
0120 #endif // _IGESAppli_NodalDisplAndRot_HeaderFile