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