SummaryCase¶
-
class
rips.
SummaryCase
(pb2_object=None, channel=None)¶ Bases:
rips.pdmobject.PdmObjectBase
The Base Class for all Summary Cases
-
auto_shorty_name
¶ Use Auto Display Name
Type: str
-
id
¶ Case ID
Type: int
-
name_setting
¶ Name Setting
Type: str
-
short_name
¶ Display Name
Type: str
-
summary_header_filename
¶ Summary Header File
Type: str
Methods Summary
available_addresses
()Arguments: available_time_steps
()Arguments: resample_values
([address, resampling_period])param address: Formatted address specifying the summary vector summary_vector_values
([address])Create a new Summary Plot :param address: Formatted address specifying the summary vector :type address: str Methods Documentation
-
available_addresses
()¶ Arguments:
Returns: DataContainerString
-
available_time_steps
()¶ Arguments:
Returns: DataContainerTime
-
resample_values
(address=None, resampling_period=None)¶ Parameters: - address (str) -- Formatted address specifying the summary vector
- resampling_period (str) -- Resampling Period
Returns: ResampleData
-
summary_vector_values
(address=None)¶ Create a new Summary Plot :param address: Formatted address specifying the summary vector :type address: str
Returns: DataContainerFloat
-