TimeSeries

TimeSeries

TimeSeries(series_type: str)

Bases: ABC

Abstract base class for OpenSees time series.

Time series instances do not self-register. A TimeSeriesManager owns tags, lookup, removal, and retagging for a local model context.

Parameters:

Name	Type	Description	Default
series_type	str	OpenSees time series type name, such as Constant or Path.	required

Attributes:

Name	Type	Description
tag	Optional[int]	Manager-assigned OpenSees tag. It remains None until the instance is added to a :class:TimeSeriesManager.
series_type		OpenSees time series type name used by concrete classes.

Attributes

tag instance-attribute

tag: Optional[int] = None

_owner instance-attribute

_owner: object | None = None

series_type instance-attribute

series_type = series_type

Methods:

_require_tag

_require_tag() -> int

Return the assigned tag or fail if the instance is unmanaged.

Concrete to_tcl implementations call this so an unmanaged object fails early instead of rendering an invalid OpenSees command.

Returns:

Type	Description
int	The manager-assigned integer tag.

Raises:

Type	Description
ValueError	If this time series has not been added to a manager.

to_tcl abstractmethod

to_tcl() -> str

Render the OpenSees timeSeries command.

Returns:

Type	Description
str	TCL command string for this time series.