GetNumExcitations

Gets the number of excitations in a design.

UI Access N/A
Parameters
Name Type Description
<ExcitationType> String Optional; Specifies the type of excitation to query. If not specified, the command will return the sum of all excitation type counts.
Return Value

Returns an integer. If no ExcitationType is specified, the integer is the sum of all excitation type counts.

If ExcitationType is specified, the integer is the number of excitations of that type.

 

Python Syntax GetNumExcitations(<ExcitationType>)
Python Example

With no ExcitationType specified:

module = design.GetModule("BoundarySetup")

module.GetNumExcitations()

returns 20

With a ExcitationType specified:

module.GetNumExcitations("Terminal")

returns 10