include/opencascade/IGESAppli_NodalResults.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_NodalResults_HeaderFile
0018 #define _IGESAppli_NodalResults_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <Standard_Real.hxx>
0024 #include <TColStd_HArray1OfInteger.hxx>
0025 #include <IGESAppli_HArray1OfNode.hxx>
0026 #include <TColStd_HArray2OfReal.hxx>
0027 #include <IGESData_IGESEntity.hxx>
0028 class IGESDimen_GeneralNote;
0029 class IGESAppli_Node;
0030
0031
0032 class IGESAppli_NodalResults;
0033 DEFINE_STANDARD_HANDLE(IGESAppli_NodalResults, IGESData_IGESEntity)
0034
0035 //! defines NodalResults, Type <146>
0036 //! in package IGESAppli
0037 //! Used to store the Analysis Data results per FEM Node
0038 class IGESAppli_NodalResults : public IGESData_IGESEntity
0039 {
0040
0041 public:
0042
0043
0044   Standard_EXPORT IGESAppli_NodalResults();
0045
0046   //! This method is used to set the fields of the class
0047   //! NodalResults
0048   //! - aNote              : General Note that describes the
0049   //! analysis case
0050   //! - aNumber            : Analysis Subcase number
0051   //! - aTime              : Analysis time
0052   //! - allNodeIdentifiers : Node identifiers for the nodes
0053   //! - allNodes           : List of FEM Node Entities
0054   //! - allData            : Values of the Finite Element analysis
0055   //! result data
0056   //! raises exception if Lengths of allNodeIdentifiers, allNodes and
0057   //! allData (Cols) are not same
0058   Standard_EXPORT void Init (const Handle(IGESDimen_GeneralNote)& aNote, const Standard_Integer aNumber, const Standard_Real aTime, const Handle(TColStd_HArray1OfInteger)& allNodeIdentifiers, const Handle(IGESAppli_HArray1OfNode)& allNodes, const Handle(TColStd_HArray2OfReal)& allData);
0059
0060   //! Changes the FormNumber (which indicates Type of Result)
0061   //! Error if not in range [0-34]
0062   Standard_EXPORT void SetFormNumber (const Standard_Integer form);
0063
0064   //! returns the General Note Entity that describes the analysis case
0065   Standard_EXPORT Handle(IGESDimen_GeneralNote) Note() const;
0066
0067   //! returns zero if there is no subcase
0068   Standard_EXPORT Standard_Integer SubCaseNumber() const;
0069
0070   //! returns the Analysis time value for this subcase. It is the time
0071   //! at which transient analysis results occur in the mathematical
0072   //! FEM model.
0073   Standard_EXPORT Standard_Real Time() const;
0074
0075   //! returns number of real values in array V for a FEM node
0076   Standard_EXPORT Standard_Integer NbData() const;
0077
0078   //! returns number of FEM nodes for which data is to be read.
0079   Standard_EXPORT Standard_Integer NbNodes() const;
0080
0081   //! returns FEM node number identifier for the (Index)th node
0082   //! raises exception if Index <= 0 or Index > NbNodes
0083   Standard_EXPORT Standard_Integer NodeIdentifier (const Standard_Integer Index) const;
0084
0085   //! returns the node as specified by the Index
0086   //! raises exception if Index <= 0 or Index > NbNodes
0087   Standard_EXPORT Handle(IGESAppli_Node) Node (const Standard_Integer Index) const;
0088
0089   //! returns the finite element analysis result value
0090   //! raises exception if (NodeNum <= 0 or NodeNum > NbNodes()) or
0091   //! if (DataNum <=0 or DataNum > NbData())
0092   Standard_EXPORT Standard_Real Data (const Standard_Integer NodeNum, const Standard_Integer DataNum) const;
0093
0094
0095
0096
0097   DEFINE_STANDARD_RTTIEXT(IGESAppli_NodalResults,IGESData_IGESEntity)
0098
0099 protected:
0100
0101
0102
0103
0104 private:
0105
0106
0107   Handle(IGESDimen_GeneralNote) theNote;
0108   Standard_Integer theSubCaseNum;
0109   Standard_Real theTime;
0110   Handle(TColStd_HArray1OfInteger) theNodeIdentifiers;
0111   Handle(IGESAppli_HArray1OfNode) theNodes;
0112   Handle(TColStd_HArray2OfReal) theData;
0113
0114
0115 };
0116
0117
0118
0119
0120
0121
0122
0123 #endif // _IGESAppli_NodalResults_HeaderFile