CircuitWire Class Reference

CircuitWire Class is used to specify the wiring of the circuit.
The class can be called from Circuit class.
. More...

Public Member Functions
Variant	GetPosition ()
	Returns the position of the terminal as a point sequence. More...
bool	IsValid ()
	Returns True if an object is valid. More...
void	Move (int dx, int dy)
	Moves the wiring by specifying the displacement. More...
void	ReverseRotate ()
	Rotates the wiring by 90 degrees anticlockwise.
void	Rotate ()
	Rotates the wiring by 90 degrees clockwise.
void	SetPosition (int sx, int sy, int ex, int ey)
	Arranges a wire by specifying the start position and end position. More...

Detailed Description

CircuitWire Class is used to specify the wiring of the circuit.
The class can be called from Circuit class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetCircuit().GetWire(0)

Member Function Documentation

Variant CircuitWire::GetPosition

(

)

Returns the position of the terminal as a point sequence.

Returns

Position of the terminal (x1, y1, x2, y2)

bool CircuitWire::IsValid

(

)

Returns True if an object is valid.

Returns

Whether or not the CircuitWire objects in the list are valid

void CircuitWire::Move	(	int	dx,
		int	dy
	)

Moves the wiring by specifying the displacement.

Parameters

dx	Displacement in the X-axis direction
dy	Displacement in the Y-axis direction

void CircuitWire::SetPosition	(	int	sx,
		int	sy,
		int	ex,
		int	ey
	)

Arranges a wire by specifying the start position and end position.

Parameters

sx	X-coordinate of the start position
sy	Y-coordinate of the start position
ex	X-coordinate of the end position
ey	Y-coordinate of the end position