next up previous contents index
Next: Electrical Devices Up: Extraction Functions Previous: Physical Subcircuits   Contents   Index

Electrical Nodes

(int) EnableNodeMap(on)
This function sets whether or not node name mapping is used in netlist output from the electrical database. If the argument is nonzero, node mapping is set, and assigned node names will be used in output. Otherwise, the node names will be the internally assigned node numbers. This function returns 1 on success, 0 otherwise.

(int) GetNumberNodes()
Return the size of the internal node map. The internal node numbers range from 0 up to but not including this value. The return value is 0 on error or if the cell is empty.

(int) SetNodeName(node, name)
This function associates the string name with the node number given in the first argument. This affects the electrical database, and is equivalent to setting a node name with the node mapping facility available in the side menu in electrical mode. When node mapping is enabled, netlist output will use the given string name rather than the node number. Since the node number is set internally, it can vary, whereas the given name is fixed. If the name given is null or empty, any existing given name is deleted, and netlist output will use the node number. The function returns 1 on success, 0 otherwise.

(string) GetNodeName(node)
This function returns a string name for the given node number. If a name has been given for that node, the name is returned, otherwise the string will consist of the node number. This will return the mapped name whether or not node mapping is enabled. If the operation fails, a null string is returned.

(int) GetNodeNumber(name)
This function returns the node number corresponding to the name string passed as an argument. If no mapping to the string is found, -1 is returned.

(int) GetNodeGroup(node)
This function returns the group index in the physical cell that corresponds to the given node number. On error, -1 is returned.

(terminal_handle) ListNodeTerminals(node)
Return a handle to the list of terminals connected to the internal node number supplied as the argument.

(stringlist_handle) ListNodeTerminalNames(node)
This function returns a string list of the terminal names tied to the given node number. These come from the electrical database. If an error occurs, 0 is returned.


next up previous contents index
Next: Electrical Devices Up: Extraction Functions Previous: Physical Subcircuits   Contents   Index
Stephen R. Whiteley 2006-10-23