include/opencascade/IGESAppli_Flow.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_Flow_HeaderFile
0018 #define _IGESAppli_Flow_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 Flow, Type <402> Form <18>
0034 //! in package IGESAppli
0035 //! Represents a single signal or a single fluid flow path
0036 //! starting from a starting Connect Point Entity and
0037 //! including additional intermediate connect points.
0038 class IGESAppli_Flow : public IGESData_IGESEntity
0039 {
0040
0041 public:
0042   Standard_EXPORT IGESAppli_Flow();
0043
0044   //! This method is used to set the fields of the class Flow
0045   //! - nbContextFlags    : Count of Context Flags, always = 2
0046   //! - aFlowType         : Type of Flow, default = 0
0047   //! - aFuncFlag         : Function Flag, default = 0
0048   //! - allFlowAssocs     : Flow Associativity Entities
0049   //! - allConnectPoints  : Connect Point Entities
0050   //! - allJoins          : Join Entities
0051   //! - allFlowNames      : Flow Names
0052   //! - allTextDisps      : Text Display Template Entities
0053   //! - allContFlowAssocs : Continuation Flow Associativity Entities
0054   Standard_EXPORT void Init(
0055     const int                                                                      nbContextFlags,
0056     const int                                                                      aFlowType,
0057     const int                                                                      aFuncFlag,
0058     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>&      allFlowAssocs,
0059     const occ::handle<NCollection_HArray1<occ::handle<IGESDraw_ConnectPoint>>>&    allConnectPoints,
0060     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>&      allJoins,
0061     const occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>>& allFlowNames,
0062     const occ::handle<NCollection_HArray1<occ::handle<IGESGraph_TextDisplayTemplate>>>&
0063                                                                               allTextDisps,
0064     const occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>& allContFlowAssocs);
0065
0066   //! forces NbContextFalgs to 2, returns True if changed
0067   Standard_EXPORT bool OwnCorrect();
0068
0069   //! returns number of Count of Context Flags, always = 2
0070   Standard_EXPORT int NbContextFlags() const;
0071
0072   //! returns number of Flow Associativity Entities
0073   Standard_EXPORT int NbFlowAssociativities() const;
0074
0075   //! returns number of Connect Point Entities
0076   Standard_EXPORT int NbConnectPoints() const;
0077
0078   //! returns number of Join Entities
0079   Standard_EXPORT int NbJoins() const;
0080
0081   //! returns number of Flow Names
0082   Standard_EXPORT int NbFlowNames() const;
0083
0084   //! returns number of Text Display Template Entities
0085   Standard_EXPORT int NbTextDisplayTemplates() const;
0086
0087   //! returns number of Continuation Flow Associativity Entities
0088   Standard_EXPORT int NbContFlowAssociativities() const;
0089
0090   //! returns Type of Flow = 0 : Not Specified (default)
0091   //! 1 : Logical
0092   //! 2 : Physical
0093   Standard_EXPORT int TypeOfFlow() const;
0094
0095   //! returns Function Flag = 0 : Not Specified (default)
0096   //! 1 : Electrical Signal
0097   //! 2 : Fluid Flow Path
0098   Standard_EXPORT int FunctionFlag() const;
0099
0100   //! returns Flow Associativity Entity
0101   //! raises exception if Index <= 0 or Index > NbFlowAssociativities()
0102   Standard_EXPORT occ::handle<IGESData_IGESEntity> FlowAssociativity(const int Index) const;
0103
0104   //! returns Connect Point Entity
0105   //! raises exception if Index <= 0 or Index > NbConnectPoints()
0106   Standard_EXPORT occ::handle<IGESDraw_ConnectPoint> ConnectPoint(const int Index) const;
0107
0108   //! returns Join Entity
0109   //! raises exception if Index <= 0 or Index > NbJoins()
0110   Standard_EXPORT occ::handle<IGESData_IGESEntity> Join(const int Index) const;
0111
0112   //! returns Flow Name
0113   //! raises exception if Index <= 0 or Index > NbFlowNames()
0114   Standard_EXPORT occ::handle<TCollection_HAsciiString> FlowName(const int Index) const;
0115
0116   //! returns Text Display Template Entity
0117   //! raises exception if Index <= 0 or Index > NbTextDisplayTemplates()
0118   Standard_EXPORT occ::handle<IGESGraph_TextDisplayTemplate> TextDisplayTemplate(
0119     const int Index) const;
0120
0121   //! returns Continuation Flow Associativity Entity
0122   //! raises exception if Index <= 0 or Index > NbContFlowAssociativities()
0123   Standard_EXPORT occ::handle<IGESData_IGESEntity> ContFlowAssociativity(const int Index) const;
0124
0125   DEFINE_STANDARD_RTTIEXT(IGESAppli_Flow, IGESData_IGESEntity)
0126
0127 private:
0128   int                                                                     theNbContextFlags;
0129   int                                                                     theTypeOfFlow;
0130   int                                                                     theFunctionFlag;
0131   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>      theFlowAssociativities;
0132   occ::handle<NCollection_HArray1<occ::handle<IGESDraw_ConnectPoint>>>    theConnectPoints;
0133   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>>      theJoins;
0134   occ::handle<NCollection_HArray1<occ::handle<TCollection_HAsciiString>>> theFlowNames;
0135   occ::handle<NCollection_HArray1<occ::handle<IGESGraph_TextDisplayTemplate>>>
0136                                                                      theTextDisplayTemplates;
0137   occ::handle<NCollection_HArray1<occ::handle<IGESData_IGESEntity>>> theContFlowAssociativities;
0138 };
0139
0140 #endif // _IGESAppli_Flow_HeaderFile