Class Reference sheetList

Listing Element for the sheet class. More...

Member

sheetList* nextSheet
sheet* thisSheet

Detailed Description

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

Sheets of a schematic are stored in a linked list. sheetList is one node of that list: thisSheet points to a sheet, and nextSheet points to the next node. The head of the list is schematic->drawing->firstSheet on the schematicDisplay. The sheet you see on screen is currentSheet; it is not necessarily the first node. Walk the list until nextSheet is NULL. You do not construct a sheetList yourself; addSheet on the display creates a new node.

Example:

sheetList *sl = schematic->drawing->firstSheet;
while (sl != NULL) {
 if (sl->thisSheet != NULL) {
 string n = sl->thisSheet->sheetName;
 }
 sl = sl->nextSheet;
}

Member Function Documentation


sheetList* sheetList::nextSheet

Pointer to the next node in the list of sheets, or NULL at the end.


sheet sheetList::thisSheet

Pointer to the sheet stored in this node.