CircuitComponentInstance class is used to specify the position or direction of a component.
The class can be called from Circuit or DynamicCircuit class.
. More...

Public Member Functions
double	GetAngle ()
	Returns the angle of the component. More...

String	GetName ()
	Returns the name of the component as a string. More...

Point *	GetPosition ()
	Returns the position of the component as a Point object. More...

String	GetScriptTypeName ()
	Returns name of the component type as a string. More...

String	GetType ()
	Returns the name of the component as a string. More...

bool	IsValid ()
	Returns True if an object is valid. More...

void	Move (int dx, int dy)
	Moves the circuit component by specifying displacement. More...

void	MoveTo (int x, int y)
	Moves the circuit component to the specified position. More...

void	ReverseRotate ()
	Rotates the circuit component by 90 degrees anticlockwise.

void	Rotate ()
	Rotates the circuit component by 90 degrees clockwise.

void	RotateTo (double angle)
	Rotates the circuit component by the specified angle. More...

void	SetComponent (Variant &component)
	Specifies a circuit component. More...

Detailed Description

CircuitComponentInstance class is used to specify the position or direction of a component.
The class can be called from Circuit or DynamicCircuit class.
.

Example of obtaining the class object:

app.GetModel(0).GetStudy(0).GetCircuit().GetInstance("Ground", 0)

Member Function Documentation

double CircuitComponentInstance::GetAngle ( )

Returns the angle of the component.

String CircuitComponentInstance::GetName ( )

Returns the name of the component as a string.

Point * CircuitComponentInstance::GetPosition ( )

Returns the position of the component as a Point object.

String CircuitComponentInstance::GetScriptTypeName ( )

Returns name of the component type as a string.

String CircuitComponentInstance::GetType ( )

Returns the name of the component as a string.

bool CircuitComponentInstance::IsValid ( )

Returns True if an object is valid.

Returns: Whether or not the CircuitComponentInstance objects in the list are valid

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

Moves the circuit component by specifying displacement.

Parameters

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

void CircuitComponentInstance::MoveTo	(	int	x,
		int	y
	)

Moves the circuit component to the specified position.

Parameters

x	X-coordinate
y	Y-coordinate

void CircuitComponentInstance::RotateTo ( double angle )

Rotates the circuit component by the specified angle.

Parameters

angle Rotation angle

void CircuitComponentInstance::SetComponent ( Variant & component )

Specifies a circuit component.

Parameters

component Circuit component