summaryrefslogtreecommitdiff
path: root/inc/IGESDraw_ConnectPoint.hxx
blob: e5e0c8b5ceedfdf0d5ad02c4248c05eaa5c09548 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _IGESDraw_ConnectPoint_HeaderFile
#define _IGESDraw_ConnectPoint_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_DefineHandle_HeaderFile
#include <Standard_DefineHandle.hxx>
#endif
#ifndef _Handle_IGESDraw_ConnectPoint_HeaderFile
#include <Handle_IGESDraw_ConnectPoint.hxx>
#endif

#ifndef _gp_XYZ_HeaderFile
#include <gp_XYZ.hxx>
#endif
#ifndef _Handle_IGESData_IGESEntity_HeaderFile
#include <Handle_IGESData_IGESEntity.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
#ifndef _Handle_TCollection_HAsciiString_HeaderFile
#include <Handle_TCollection_HAsciiString.hxx>
#endif
#ifndef _Handle_IGESGraph_TextDisplayTemplate_HeaderFile
#include <Handle_IGESGraph_TextDisplayTemplate.hxx>
#endif
#ifndef _IGESData_IGESEntity_HeaderFile
#include <IGESData_IGESEntity.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
class IGESData_IGESEntity;
class TCollection_HAsciiString;
class IGESGraph_TextDisplayTemplate;
class gp_XYZ;
class gp_Pnt;


//! defines IGESConnectPoint, Type <132> Form Number <0> <br>
//!           in package IGESDraw <br>
class IGESDraw_ConnectPoint : public IGESData_IGESEntity {

public:

  
  Standard_EXPORT   IGESDraw_ConnectPoint();
  //! This method is used to set the fields of the class <br>
//!           ConnectPoint <br>
//!       - aPoint               : A Coordinate point <br>
//!       - aDisplaySymbol       : Display symbol Geometry <br>
//!       - aTypeFlag            : Type of the connection <br>
//!       - aFunctionFlag        : Function flag for the connection <br>
//!       - aFunctionIdentifier  : Connection Point Function Identifier <br>
//!       - anIdentifierTemplate : Connection Point Function Template <br>
//!       - aFunctionName        : Connection Point Function Name <br>
//!       - aFunctionTemplate    : Connection Point Function Template <br>
//!       - aPointIdentifier     : Unique Connect Point Identifier <br>
//!       - aFunctionCode        : Connect Point Function Code <br>
//!       - aSwapFlag            : Connect Point Swap Flag <br>
//!       - anOwnerSubfigure     : Pointer to the "Owner" Entity <br>
  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) ;
  //! returns the coordinate of the connection point <br>
  Standard_EXPORT     gp_Pnt Point() const;
  //! returns the Transformed coordinate of the connection point <br>
  Standard_EXPORT     gp_Pnt TransformedPoint() const;
  //! returns True if Display symbol is specified <br>
//! else returns False <br>
  Standard_EXPORT     Standard_Boolean HasDisplaySymbol() const;
  //! if display symbol specified returns display symbol geometric entity <br>
//! else returns NULL Handle <br>
  Standard_EXPORT     Handle_IGESData_IGESEntity DisplaySymbol() const;
  //! return value specifies a particular type of connection : <br>
//!          Type Flag = 0   : Not Specified(default) <br>
//!                      1   : Nonspecific logical  point of connection <br>
//!                      2   : Nonspecific physical point of connection <br>
//!                      101 : Logical component pin <br>
//!                      102 : Logical part connector <br>
//!                      103 : Logical offpage connector <br>
//!                      104 : Logical global signal connector <br>
//!                      201 : Physical PWA surface mount pin <br>
//!                      202 : Physical PWA blind pin <br>
//!                      203 : Physical PWA thru-pin <br>
//!                5001-9999 : Implementor defined. <br>
  Standard_EXPORT     Standard_Integer TypeFlag() const;
  //! returns Function Code that specifies a particular function for the <br>
//! ECO576 connection : <br>
//! e.g.,        Function Flag = 0 : Unspecified(default) <br>
//!                            = 1 : Electrical Signal <br>
//!                            = 2 : Fluid flow Signal <br>
  Standard_EXPORT     Standard_Integer FunctionFlag() const;
  //! return HAsciiString identifying Pin Number or Nozzle Label etc. <br>
  Standard_EXPORT     Handle_TCollection_HAsciiString FunctionIdentifier() const;
  //! returns True if Text Display Template is specified for Identifier <br>
//! else returns False <br>
  Standard_EXPORT     Standard_Boolean HasIdentifierTemplate() const;
  //! if Text Display Template for the Function Identifier is defined, <br>
//! returns TestDisplayTemplate <br>
//! else returns NULL Handle <br>
  Standard_EXPORT     Handle_IGESGraph_TextDisplayTemplate IdentifierTemplate() const;
  //! returns Connection Point Function Name <br>
  Standard_EXPORT     Handle_TCollection_HAsciiString FunctionName() const;
  //! returns True if Text Display Template is specified for Function Name <br>
//! else returns False <br>
  Standard_EXPORT     Standard_Boolean HasFunctionTemplate() const;
  //! if Text Display Template for the Function Name is defined, <br>
//! returns TestDisplayTemplate <br>
//! else returns NULL Handle <br>
  Standard_EXPORT     Handle_IGESGraph_TextDisplayTemplate FunctionTemplate() const;
  //! returns the Unique Connect Point Identifier <br>
  Standard_EXPORT     Standard_Integer PointIdentifier() const;
  //! returns the Connect Point Function Code <br>
  Standard_EXPORT     Standard_Integer FunctionCode() const;
  //! return value = 0 : Connect point may be swapped(default) <br>
//!              = 1 : Connect point may not be swapped <br>
  Standard_EXPORT     Standard_Boolean SwapFlag() const;
  //! returns True if Network Subfigure Instance/Definition Entity <br>
//! is specified <br>
//! else returns False <br>
  Standard_EXPORT     Standard_Boolean HasOwnerSubfigure() const;
  //! returns "owner" Network Subfigure Instance Entity, <br>
//! or Network Subfigure Definition Entity, or NULL Handle. <br>
  Standard_EXPORT     Handle_IGESData_IGESEntity OwnerSubfigure() const;




  DEFINE_STANDARD_RTTI(IGESDraw_ConnectPoint)

protected:




private: 


gp_XYZ thePoint;
Handle_IGESData_IGESEntity theDisplaySymbol;
Standard_Integer theTypeFlag;
Standard_Integer theFunctionFlag;
Handle_TCollection_HAsciiString theFunctionIdentifier;
Handle_IGESGraph_TextDisplayTemplate theIdentifierTemplate;
Handle_TCollection_HAsciiString theFunctionName;
Handle_IGESGraph_TextDisplayTemplate theFunctionTemplate;
Standard_Integer thePointIdentifier;
Standard_Integer theFunctionCode;
Standard_Integer theSwapFlag;
Handle_IGESData_IGESEntity theOwnerSubfigure;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif