include/opencascade/IGESDraw_ConnectPoint.hxx

0001 // Created on: 1993-01-11
0002 // Created by: CKY / Contract Toubro-Larsen ( Niraj RANGWALA )
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 _IGESDraw_ConnectPoint_HeaderFile
0018 #define _IGESDraw_ConnectPoint_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_Type.hxx>
0022
0023 #include <gp_XYZ.hxx>
0024 #include <Standard_Integer.hxx>
0025 #include <IGESData_IGESEntity.hxx>
0026 class TCollection_HAsciiString;
0027 class IGESGraph_TextDisplayTemplate;
0028 class gp_Pnt;
0029
0030
0031 class IGESDraw_ConnectPoint;
0032 DEFINE_STANDARD_HANDLE(IGESDraw_ConnectPoint, IGESData_IGESEntity)
0033
0034 //! defines IGESConnectPoint, Type <132> Form Number <0>
0035 //! in package IGESDraw
0036 //!
0037 //! Connect Point Entity describes a point of connection for
0038 //! zero, one or more entities. Its referenced from Composite
0039 //! curve, or Network Subfigure Definition/Instance, or Flow
0040 //! Associative Instance, or it may stand alone.
0041 class IGESDraw_ConnectPoint : public IGESData_IGESEntity
0042 {
0043
0044 public:
0045
0046
0047   Standard_EXPORT IGESDraw_ConnectPoint();
0048
0049   //! This method is used to set the fields of the class
0050   //! ConnectPoint
0051   //! - aPoint               : A Coordinate point
0052   //! - aDisplaySymbol       : Display symbol Geometry
0053   //! - aTypeFlag            : Type of the connection
0054   //! - aFunctionFlag        : Function flag for the connection
0055   //! - aFunctionIdentifier  : Connection Point Function Identifier
0056   //! - anIdentifierTemplate : Connection Point Function Template
0057   //! - aFunctionName        : Connection Point Function Name
0058   //! - aFunctionTemplate    : Connection Point Function Template
0059   //! - aPointIdentifier     : Unique Connect Point Identifier
0060   //! - aFunctionCode        : Connect Point Function Code
0061   //! - aSwapFlag            : Connect Point Swap Flag
0062   //! - anOwnerSubfigure     : Pointer to the "Owner" Entity
0063   Standard_EXPORT void Init (const gp_XYZ& aPoint, const Handle(IGESData_IGESEntity)& aDisplaySymbol, const Standard_Integer aTypeFlag, const Standard_Integer aFunctionFlag, const Handle(TCollection_HAsciiString)& aFunctionIdentifier, const Handle(IGESGraph_TextDisplayTemplate)& anIdentifierTemplate, const Handle(TCollection_HAsciiString)& aFunctionName, const Handle(IGESGraph_TextDisplayTemplate)& aFunctionTemplate, const Standard_Integer aPointIdentifier, const Standard_Integer aFunctionCode, const Standard_Integer aSwapFlag, const Handle(IGESData_IGESEntity)& anOwnerSubfigure);
0064
0065   //! returns the coordinate of the connection point
0066   Standard_EXPORT gp_Pnt Point() const;
0067
0068   //! returns the Transformed coordinate of the connection point
0069   Standard_EXPORT gp_Pnt TransformedPoint() const;
0070
0071   //! returns True if Display symbol is specified
0072   //! else returns False
0073   Standard_EXPORT Standard_Boolean HasDisplaySymbol() const;
0074
0075   //! if display symbol specified returns display symbol geometric entity
0076   //! else returns NULL Handle
0077   Standard_EXPORT Handle(IGESData_IGESEntity) DisplaySymbol() const;
0078
0079   //! return value specifies a particular type of connection :
0080   //! Type Flag = 0   : Not Specified(default)
0081   //! 1   : Nonspecific logical  point of connection
0082   //! 2   : Nonspecific physical point of connection
0083   //! 101 : Logical component pin
0084   //! 102 : Logical part connector
0085   //! 103 : Logical offpage connector
0086   //! 104 : Logical global signal connector
0087   //! 201 : Physical PWA surface mount pin
0088   //! 202 : Physical PWA blind pin
0089   //! 203 : Physical PWA thru-pin
0090   //! 5001-9999 : Implementor defined.
0091   Standard_EXPORT Standard_Integer TypeFlag() const;
0092
0093   //! returns Function Code that specifies a particular function for the
0094   //! ECO576 connection :
0095   //! e.g.,        Function Flag = 0 : Unspecified(default)
0096   //! = 1 : Electrical Signal
0097   //! = 2 : Fluid flow Signal
0098   Standard_EXPORT Standard_Integer FunctionFlag() const;
0099
0100   //! return HAsciiString identifying Pin Number or Nozzle Label etc.
0101   Standard_EXPORT Handle(TCollection_HAsciiString) FunctionIdentifier() const;
0102
0103   //! returns True if Text Display Template is specified for Identifier
0104   //! else returns False
0105   Standard_EXPORT Standard_Boolean HasIdentifierTemplate() const;
0106
0107   //! if Text Display Template for the Function Identifier is defined,
0108   //! returns TestDisplayTemplate
0109   //! else returns NULL Handle
0110   Standard_EXPORT Handle(IGESGraph_TextDisplayTemplate) IdentifierTemplate() const;
0111
0112   //! returns Connection Point Function Name
0113   Standard_EXPORT Handle(TCollection_HAsciiString) FunctionName() const;
0114
0115   //! returns True if Text Display Template is specified for Function Name
0116   //! else returns False
0117   Standard_EXPORT Standard_Boolean HasFunctionTemplate() const;
0118
0119   //! if Text Display Template for the Function Name is defined,
0120   //! returns TestDisplayTemplate
0121   //! else returns NULL Handle
0122   Standard_EXPORT Handle(IGESGraph_TextDisplayTemplate) FunctionTemplate() const;
0123
0124   //! returns the Unique Connect Point Identifier
0125   Standard_EXPORT Standard_Integer PointIdentifier() const;
0126
0127   //! returns the Connect Point Function Code
0128   Standard_EXPORT Standard_Integer FunctionCode() const;
0129
0130   //! return value = 0 : Connect point may be swapped(default)
0131   //! = 1 : Connect point may not be swapped
0132   Standard_EXPORT Standard_Boolean SwapFlag() const;
0133
0134   //! returns True if Network Subfigure Instance/Definition Entity
0135   //! is specified
0136   //! else returns False
0137   Standard_EXPORT Standard_Boolean HasOwnerSubfigure() const;
0138
0139   //! returns "owner" Network Subfigure Instance Entity,
0140   //! or Network Subfigure Definition Entity, or NULL Handle.
0141   Standard_EXPORT Handle(IGESData_IGESEntity) OwnerSubfigure() const;
0142
0143
0144
0145
0146   DEFINE_STANDARD_RTTIEXT(IGESDraw_ConnectPoint,IGESData_IGESEntity)
0147
0148 protected:
0149
0150
0151
0152
0153 private:
0154
0155
0156   gp_XYZ thePoint;
0157   Handle(IGESData_IGESEntity) theDisplaySymbol;
0158   Standard_Integer theTypeFlag;
0159   Standard_Integer theFunctionFlag;
0160   Handle(TCollection_HAsciiString) theFunctionIdentifier;
0161   Handle(IGESGraph_TextDisplayTemplate) theIdentifierTemplate;
0162   Handle(TCollection_HAsciiString) theFunctionName;
0163   Handle(IGESGraph_TextDisplayTemplate) theFunctionTemplate;
0164   Standard_Integer thePointIdentifier;
0165   Standard_Integer theFunctionCode;
0166   Standard_Boolean theSwapFlag;
0167   Handle(IGESData_IGESEntity) theOwnerSubfigure;
0168
0169
0170 };
0171
0172
0173
0174
0175
0176
0177
0178 #endif // _IGESDraw_ConnectPoint_HeaderFile