File: IGESDraw_ConnectPoint.hxx

package info (click to toggle)
oce 0.18.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 301,548 kB
  • sloc: cpp: 1,190,609; ansic: 67,225; sh: 11,630; tcl: 7,954; cs: 5,221; python: 2,867; java: 1,522; makefile: 342; xml: 292; perl: 37
file content (171 lines) | stat: -rw-r--r-- 6,563 bytes parent folder | download | duplicates (5)
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
169
170
171
// 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

#include <Standard.hxx>
#include <Standard_DefineHandle.hxx>
#include <Handle_IGESDraw_ConnectPoint.hxx>

#include <gp_XYZ.hxx>
#include <Handle_IGESData_IGESEntity.hxx>
#include <Standard_Integer.hxx>
#include <Handle_TCollection_HAsciiString.hxx>
#include <Handle_IGESGraph_TextDisplayTemplate.hxx>
#include <IGESData_IGESEntity.hxx>
#include <Standard_Boolean.hxx>
class IGESData_IGESEntity;
class TCollection_HAsciiString;
class IGESGraph_TextDisplayTemplate;
class gp_XYZ;
class gp_Pnt;


//! defines IGESConnectPoint, Type <132> Form Number <0>
//! in package IGESDraw
//!
//! Connect Point Entity describes a point of connection for
//! zero, one or more entities. Its referenced from Composite
//! curve, or Network Subfigure Definition/Instance, or Flow
//! Associative Instance, or it may stand alone.
class IGESDraw_ConnectPoint : public IGESData_IGESEntity
{

public:

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


};







#endif // _IGESDraw_ConnectPoint_HeaderFile