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