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

One of [FULL_CASE_NAME, SHORT_CASE_NAME, CUSTOM_NAME]

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]) Get all values for a summary vector

Methods Documentation

available_addresses()

Arguments:

Returns:DataContainerString
available_time_steps()

Arguments:

Returns:DataContainerTime
resample_values(address='', resampling_period='')
Parameters:
  • address (str) -- Formatted address specifying the summary vector
  • resampling_period (str) -- Resampling Period
Returns:

ResampleData

summary_vector_values(address='')

Get all values for a summary vector

Parameters:address (str) -- Formatted address specifying the summary vector
Returns:DataContainerFloat