Class Reference sheet

A sheet in the schematic. More...

Member

sElement*	addArc(pointArray p,int red, int green, int blue)
sElement*	addBus(pointArray p)
sElement*	addBusport(point p,string text)
sElement*	addCircle(point p1,QPoint p2,int red, int green, int blue)
sElement*	addGround(point p)
sElement*	addPlacement(string name,string lib, point pos, strans trans_)
sElement*	addPlacement(component *, point pos, strans trans_)
sElement*	addPort(point p,string text)
sElement*	addPolyline(pointArray p,int red, int green, int blue)
sElement*	addPolygon(pointArray p,int red, int green, int blue)
sElement*	addRect(point p1,QPoint p2,int red, int green, int blue)
sElement*	addText(point p,int red, int green, int blue, string textt)
sElement*	addWire(pointArray p)
sElement*	addWireLabel(point p)
void	deleteElement( sElement* element)
bool	existsDevicename(string name)
sElementList*	firstElement
sElement *	getDevice(string name)
component *	getSheetComponent()
string	getUnusedDevicename(string prefix)
string	sheetName

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 ce thisClas class cl,la,el,dr clas

This class contains many methods for a macro controlled schematic generation.

Member Function Documentation

sElement* sheet::addArc(pointArray p,int red, int green, int blue)

adds an arc to the sheet.

sElement* sheet::addBus(pointArray p)

adds a bus

sElement* sheet::addBusport(point p,string text)

adds a bus port

sElement* sheet::addCircle(point p1,QPoint p2,int red, int green, int blue)

adds a circle to the sheet.

sElement* sheet::addGround(point p)

adds a ground

sElement* sheet::addPlacement(string name,string lib, point pos, strans trans_)

adds a placement of a component

sElement* sheet::addPlacement(component *, point pos, strans trans_)

adds a placement of a component

sElement* sheet::addPort(point p,string text)

adds a port

sElement* sheet::addPolyline(pointArray p,int red, int green, int blue)

adds a polyline to the sheet.

sElement* sheet::addPolygon(pointArray p,int red, int green, int blue)

adds a polygon to the sheet.

sElement* sheet::addRect(point p1,QPoint p2,int red, int green, int blue)

adds a rectangle to the sheet.

sElement* sheet::addText(point p,int red, int green, int blue, string textt)

adds a text to the sheet.

sElement* sheet::addWire(pointArray p)

adds a wire

sElement* sheet::addWireLabel(point p)

adds a wire label at the point p

void sheet::deleteElement( sElement* element)

The specified element will be deleted from the sheet. (introduced with release 20180501)

bool sheet::existsDevicename(string name)

Returns: true, if a device with name exist. If it not exists, it returns false.

sElementList* sheet::firstElement

This is a list of all elements in this sheet.

sElement * sheet::getDevice(string name)

Returns: a point to the device with name. If it not exists, it returns NULL.

component * sheet::getSheetComponent()

Returns: a pointer to the component created from this sheet. A NULL pointer is returned, if this component was not used to create a component. (introduced with release 20180501)

string sheet::getUnusedDevicename(string prefix)

Returns: an unused devicename with the given prefix.

string sheet::sheetName

The name of this sheet