Source code for py_dss_interface.models.DSSExecutive.DSSExecutive
# -*- encoding: utf-8 -*-
"""
Created by eniocc at 11/10/2020
"""
from py_dss_interface.models.DSSExecutive.DSSExecutiveI import DSSExecutiveI
from py_dss_interface.models.DSSExecutive.DSSExecutiveS import DSSExecutiveS
[docs]class DSSExecutive(DSSExecutiveS, DSSExecutiveI):
"""
This interface implements the DSS_Executive (IDSS_Executive) interface of OpenDSS by declaring 2 procedures for
accessing the different properties included in this interface: DSSExecutiveS, DSSExecutiveI
"""
def __init__(self, obj_dss):
super().__init__(obj_dss)
@property
def num_commands(self) -> int:
"""Gets the number of DSS Executive Commands."""
return DSSExecutiveI._num_commands(self)
@property
def num_options(self) -> int:
"""Gets the number of DSS Executive Options."""
return DSSExecutiveI._num_options(self)
[docs] def command(self, arg: str) -> str:
"""Gets i-th command (specified in the argument as string)."""
return DSSExecutiveS._command(self, arg)
[docs] def option(self, arg: str) -> str:
"""Gets i-th option (specified in the argument as string)."""
return DSSExecutiveS._option(self, arg)
[docs] def command_help(self, arg: str) -> str:
"""Gets help string for i-th command (specified in the argument as string)."""
return DSSExecutiveS._command_help(self, arg)
[docs] def option_help(self, arg: str) -> str:
"""Gets help string for i-th option (specified in the argument as string)."""
return DSSExecutiveS._option_help(self, arg)
[docs] def option_value(self, arg: str) -> str:
"""Gets present value for i-th option (specified in the argument as string)."""
return DSSExecutiveS._option_value(self, arg)