pleiades.sammy.parameters.unused_var module

Data class for card 05::unused but correlated variables.

class pleiades.sammy.parameters.unused_var.UnusedVariable(*, name: str, value: float)

Bases: BaseModel

Container for a single unused but correlated variable.

Contains: - name: 5-character name of the variable - value: Numerical value of the variable

name: str

value: float

validate_name_length() → UnusedVariable

Validate that name is exactly 5 characters.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pleiades.sammy.parameters.unused_var.UnusedCorrelatedParameters(*, variables: List[UnusedVariable] = <factory>)

Bases: BaseModel

Container for a set of unused but correlated variables.

Contains: - variables: List of UnusedVariable objects

variables: List[UnusedVariable]

classmethod from_lines(lines: List[str]) → UnusedCorrelatedParameters

Parse unused correlated parameters from pairs of name/value lines.

Parameters:

lines – List of input lines (excluding header)

Returns:

Parsed parameters

Return type:

UnusedCorrelatedParameters

Raises:

ValueError – If lines are invalid or required data is missing

to_lines() → List[str]

Convert the parameters to a list of fixed-width format lines.

Returns:

Lines representing the parameters

Return type:

List[str]

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pleiades.sammy.parameters.unused_var.UnusedCorrelatedCard(*, parameters: UnusedCorrelatedParameters)

Bases: BaseModel

Container for a complete unused correlated variable card set (Card Set 5).

This class handles a complete card set, including: - Header line - Parameter entries - Trailing blank line

parameters: UnusedCorrelatedParameters

classmethod is_header_line(line: str) → bool

Check if line is a valid header line.

Parameters:

line – Input line to check

Returns:

True if line is a valid header

Return type:

bool

classmethod from_lines(lines: List[str]) → UnusedCorrelatedCard

Parse a complete card set from lines.

Parameters:

lines – List of input lines including header

Returns:

Parsed card set

Return type:

UnusedCorrelatedCard

Raises:

ValueError – If no valid header found or invalid format

to_lines() → List[str]

Convert the card set to a list of lines.

Returns:

Lines including header and parameters

Return type:

List[str]

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].