include/opencascade/IGESAppli_PipingFlow.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Anand NATRAJAN )
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_PipingFlow_HeaderFile
0018 #define _IGESAppli_PipingFlow_HeaderFile
0019
0020 #include <Standard.hxx>
0021
0022 #include <Standard_Integer.hxx>
0023 #include <IGESData_IGESEntity.hxx>
0024 #include <NCollection_Array1.hxx>
0025 #include <NCollection_HArray1.hxx>
0026 #include <IGESDraw_ConnectPoint.hxx>
0027 #include <TCollection_HAsciiString.hxx>
0028 #include <IGESGraph_TextDisplayTemplate.hxx>
0029 class IGESDraw_ConnectPoint;
0030 class TCollection_HAsciiString;
0031 class IGESGraph_TextDisplayTemplate;
0032
0033 //! defines PipingFlow, Type <402> Form <20>
0034 //! in package IGESAppli
0035 //! Represents a single fluid flow path
0036 class IGESAppli_PipingFlow : public IGESData_IGESEntity
0037 {
0038
0039 public:
0040   Standard_EXPORT IGESAppli_PipingFlow();
0041
0042   //! This method is used to set the fields of the class
0043   //! PipingFlow
0044   //! - nbContextFlags    : Count of Context Flags, always = 1
0045   //! - aFlowType         : Type of Flow, default = 0
0046   //! - allFlowAssocs     : PipingFlow Associativity Entities
0047   //! - allConnectPoints  : Connect Point Entities
0048   //! - allJoins          : Join Entities
0049   //! - allFlowNames      : PipingFlow Names
0050   //! - allTextDispTs     : Text Display Template Entities
0051   //! - allContFlowAssocs : Continuation Flow Associativity Entities
0052   Standard_EXPORT void Init(
0053     const int                                                                      nbContextFlags,
0054     const int                                                                      aFlowType,
0055     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>&      allFlowAssocs,
0056     const occ::handle<NCollection_HArray1<occ::handle<IGESDraw_ConnectPoint>>>&    allConnectPoints,
0057     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>&      allJoins,
0058     const occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>>& allFlowNames,
0059     const occ::handle<NCollection_HArray1<occ::handle<IGESGraph_TextDisplayTemplate>>>&
0060                                                                               allTextDisps,
0061     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>& allContFlowAssocs);
0062
0063   //! forces NbContextFalgs to 1, returns True if changed
0064   Standard_EXPORT bool OwnCorrect();
0065
0066   //! returns number of Count of Context Flags, always = 1
0067   Standard_EXPORT int NbContextFlags() const;
0068
0069   //! returns number of Piping Flow Associativity Entities
0070   Standard_EXPORT int NbFlowAssociativities() const;
0071
0072   //! returns number of Connect Point Entities
0073   Standard_EXPORT int NbConnectPoints() const;
0074
0075   //! returns number of Join Entities
0076   Standard_EXPORT int NbJoins() const;
0077
0078   //! returns number of Flow Names
0079   Standard_EXPORT int NbFlowNames() const;
0080
0081   //! returns number of Text Display Template Entities
0082   Standard_EXPORT int NbTextDisplayTemplates() const;
0083
0084   //! returns number of Continuation Piping Flow Associativities
0085   Standard_EXPORT int NbContFlowAssociativities() const;
0086
0087   //! returns Type of Flow = 0 : Not specified,
0088   //! 1 : Logical,
0089   //! 2 : Physical
0090   Standard_EXPORT int TypeOfFlow() const;
0091
0092   //! returns Piping Flow Associativity Entity
0093   //! raises exception if Index <= 0 or Index > NbFlowAssociativities()
0094   Standard_EXPORT occ::handle<IGESData_IGESEntity> FlowAssociativity(const int Index) const;
0095
0096   //! returns Connect Point Entity
0097   //! raises exception if Index <= 0 or Index > NbConnectPoints()
0098   Standard_EXPORT occ::handle<IGESDraw_ConnectPoint> ConnectPoint(const int Index) const;
0099
0100   //! returns Join Entity
0101   //! raises exception if Index <= 0 or Index > NbJoins()
0102   Standard_EXPORT occ::handle<IGESData_IGESEntity> Join(const int Index) const;
0103
0104   //! returns Flow Name
0105   //! raises exception if Index <= 0 or Index > NbFlowNames()
0106   Standard_EXPORT occ::handle<TCollection_HAsciiString> FlowName(const int Index) const;
0107
0108   //! returns Text Display Template Entity
0109   //! raises exception if Index <= 0 or Index > NbTextDisplayTemplates()
0110   Standard_EXPORT occ::handle<IGESGraph_TextDisplayTemplate> TextDisplayTemplate(
0111     const int Index) const;
0112
0113   //! returns Continuation Piping Flow Associativity Entity
0114   //! raises exception if Index <= 0 or Index > NbContFlowAssociativities()
0115   Standard_EXPORT occ::handle<IGESData_IGESEntity> ContFlowAssociativity(const int Index) const;
0116
0117   DEFINE_STANDARD_RTTIEXT(IGESAppli_PipingFlow, IGESData_IGESEntity)
0118
0119 private:
0120   int                                                                     theNbContextFlags;
0121   int                                                                     theTypeOfFlow;
0122   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>      theFlowAssociativities;
0123   occ::handle<NCollection_HArray1<occ::handle<IGESDraw_ConnectPoint>>>    theConnectPoints;
0124   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>      theJoins;
0125   occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>> theFlowNames;
0126   occ::handle<NCollection_HArray1<occ::handle<IGESGraph_TextDisplayTemplate>>>
0127                                                                      theTextDisplayTemplates;
0128   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>> theContFlowAssociativities;
0129 };
0130
0131 #endif // _IGESAppli_PipingFlow_HeaderFile