MacroCircuit class is used when registering created circuit components as a macro component.
The class can be called from Circuit class.
. More...

Public Member Functions
void	AddInstance (Variant &val)
	Adds an instance of a circuit component to a macro component. More...

void	AddLeftTerminal (int x, int y)
	Specifies a terminal added to [Left Terminals] of a macro component from coordinates (x, y). More...

void	AddRightTerminal (int x, int y)
	Specifies a terminal added to [Right Terminals] of a macro component from coordinates (x, y). More...

void	AddWire (int index)
	Adds a wire. More...

void	Create ()
	Creates a macro circuit component. The created macro circuit component is added to the macro component list.

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

void	SetDescription (String &description)
	Specifies the description of macro component. More...

void	SetFolder (String &folder)
	Specifies the folder path of macro component. More...

Detailed Description

MacroCircuit class is used when registering created circuit components as a macro component.
The class can be called from Circuit class.
.

Example of calling the class object:

app.GetModel(0).GetStudy(0).GetCircuit().CreateMacro("macro_title")

Member Function Documentation

void MacroCircuit::AddInstance ( Variant & val )

Adds an instance of a circuit component to a macro component.

Parameters

val	Name or index of the circuit component

void MacroCircuit::AddLeftTerminal	(	int	x,
		int	y
	)

Specifies a terminal added to [Left Terminals] of a macro component from coordinates (x, y).

Parameters

x	X-coordinate of terminal
y	Y-coordinate of terminal

void MacroCircuit::AddRightTerminal	(	int	x,
		int	y
	)

Specifies a terminal added to [Right Terminals] of a macro component from coordinates (x, y).

Parameters

x	X-coordinate of terminal
y	Y-coordinate of terminal

void MacroCircuit::AddWire ( int index )

Adds a wire.

Parameters

index Index of wire

bool MacroCircuit::IsValid ( )

Returns True if an object is valid.

void MacroCircuit::SetDescription ( String & description )

Specifies the description of macro component.

Parameters

description Description

void MacroCircuit::SetFolder ( String & folder )

Specifies the folder path of macro component.

Parameters

folder Folder Path