Class Reference schematicDisplay

The main class of a schematic. More...

Member

sheetList*	addSheet()
sheet*	currentSheet
void	deleteCurrentSheet()
void	deleteSheet(sheet *sheet)
sheet*	findSheet(string search)
sheetList*	firstSheet
string	generateNetList(string type,string filename="")
bool	modified()
void	openFile(string s)
void	openView(string library,string cellName,string viewName)
void	saveFile(string s)
void	saveNetList(string filename, string type)
void	setProbeMode(plotData data)
bool	setSheet(string s)
void	setSheet(sheet *s)
void	scaleFull()
void	scaleMinus()
void	scalePlus()
void	scrollDown()
void	scrollLeft()
void	scrollRight()
void	scrollUp()
void	updateNetlist()
void	updateCurrentNetlist()
void	updateCurrentNetlistDevices()

Detailed Description

graph LR la(schematic)--drawing-->dr(schematicDisplay) dr==firstSheet==>cl(sheetList) dr==currentSheet==>ce cl--thisSheet-->ce(sheet) cl--nextSheet-->cl ce--firstElement-->el(sElementList) click ce "/layoutscript/api/sheet" click cl "/layoutscript/api/sheetlist" click el "/layoutscript/api/selementlist" click la "/layoutscript/api/schematic" click dr "/layoutscript/api/schematicdisplay" classDef thisClas fill:#eaf5fc,stroke:#3c7faa,stroke-width:4px; classDef clas fill:#eaf5fc,stroke:#3c7faa,stroke-width:1px; class dr thisClas class cl,la,el,ce clas

The main widget of the schematic window. It contains all data of existing sheets.

Member Function Documentation

sheetList* schematicDisplay::addSheet()

Adds a new sheet to the sheetlist.

sheet schematicDisplay::currentSheet

This is a pointer on the sheet displayed.

void schematicDisplay::deleteCurrentSheet()

The current sheet is deleted.

void schematicDisplay::deleteSheet(sheet *sheet)

The specified sheet is deleted.

sheet schematicDisplay::findSheet(string search)

Searches and return a sheet with the given name. (introduced with release 20190808)

sheetList* schematicDisplay::firstSheet

This is a list of all sheets in the drawing.

string schematicDisplay::generateNetList(string type,string filename="")

Returns: the current sheet as a netlist. type had to be defined in the setup before. filename is be use as information only in the generated netlist.

bool schematicDisplay::modified()

Returns: true ,if the design was modifies after the last save

void schematicDisplay::openFile(string s)

A file with the name s is opened.

void schematicDisplay::openView(string library,string cellName,string viewName)

opens the given openaccess view as schematic

void schematicDisplay::saveFile(string s)

The current sheet collection is as with the name s

void schematicDisplay::saveNetList(string filename, string type)

exports the current sheet as netlist. Type had to be defined in the setup before.

void schematicDisplay::setProbeMode(plotData data)

Will set the SchematicEditor to a probe mode. In this mode by clicking nodes, devices and ports another macro will be triggered. data as well the clicked node, device or port will be given to that macro and can be used to display simulation results.

bool schematicDisplay::setSheet(string s)

The current sheet is set to the sheet with the name s. If a sheet with that name does not exist false is returned, otherwise true. (introduced with release 20190808)

void schematicDisplay::setSheet(sheet *s)

The current sheet is set to s. (introduced with release 20190808)

void schematicDisplay::scaleFull()

The current sheet is scalled in a way that is completely visible.

void schematicDisplay::scaleMinus()

The scale is decreased,

void schematicDisplay::scalePlus()

The scale is increased,

void schematicDisplay::scrollDown()

The current view is scrolled down.

void schematicDisplay::scrollLeft()

The current view is scrolled left.

void schematicDisplay::scrollRight()

The current view is scrolled right.

void schematicDisplay::scrollUp()

The current view is scrolled up.

void schematicDisplay::updateNetlist()

Will extract netlists in all sheets. Call it to sync layout window netlist after modification of sheets.

void schematicDisplay::updateCurrentNetlist()

Will extract netlists in the current sheet.

void schematicDisplay::updateCurrentNetlistDevices()

will update any device on the current displayed netlist within the layout window. Call it after changing parameter of existing devices or after adding new device with a macro. (introduced with release 20191223)