get_summary#

VolumeControl.get_summary(params)#

Gets the volume control summary along with the evaluated scope for the provided parameters.

Parameters:
paramsVolumeControlSummaryParams

Volume control summary parameters.

Returns:
:
VolumeControlSummaryResults

Return the VolumeControlSummaryResults.

Return type:

VolumeControlSummaryResults

Examples

>>> results = volume_control.get_summary(prime.VolumeControlSummaryParams(model=model))