SummaryCase

class rips.SummaryCase(pb2_object: PdmObject | None = None, channel: Channel | None = None)

Bases: PdmObjectBase

The Base Class for all Summary Cases

auto_shorty_name

Use Auto Display Name

Type:

bool

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

show_sub_nodes_in_tree

Show Summary Data Sub-Tree

Type:

bool

summary_header_filename

Summary Header File

Type:

Optional[str]

Methods Summary

available_addresses()	Arguments:
available_time_steps()	Arguments:
resample_values([address, resampling_period])	param address: Formatted address specifying the summary vector
set_summary_values([address, unit, values])	param address: Formatted address specifying the summary vector
summary_vector_values([address])	Get all values for a summary vector

Methods Documentation

available_addresses() → DataContainerString

Arguments:

Returns:

DataContainerString

available_time_steps() → DataContainerTime

Arguments:

Returns:

DataContainerTime

resample_values(address: str = '', resampling_period: str = '') → ResampleData

Parameters:

• address (str) -- Formatted address specifying the summary vector

• resampling_period (str) -- Resampling Period

Returns:

ResampleData

set_summary_values(address: str = '', unit: str = '', values: List[float] = []) → None

Parameters:

• address (str) -- Formatted address specifying the summary vector

• unit (str) -- Unit

• values (List[float]) -- Values

Returns:

summary_vector_values(address: str = '') → DataContainerFloat

Get all values for a summary vector

Parameters:

address (str) -- Formatted address specifying the summary vector

Returns:

DataContainerFloat