API reference / Archive, sampling contract and types

tsdive.TagMeta dataclass

TagMeta(
    identity: TagIdentity,
    name: str,
    *,
    unit_raw: str | None = None,
    unit_canonical: str | None = None,
    eng_range: EngRange | None = None,
    sample_rate_s: float | None = None,
    asset: str | None = None,
    loop_id: str | None = None,
    role: Role | None = None,
    retrieval_mode: RetrievalMode | None = None,
    quality_codes: dict[str, str] | None = None,
    quality_assumed: bool = False,
)

Static metadata for one tag.

A field the source does not state is None, never a placeholder like 1.0 or 0.

Methods:

Name	Description
__post_init__

Attributes:

Name	Type	Description
identity	TagIdentity
name	str
unit_raw	str | None
unit_canonical	str | None
eng_range	EngRange | None
sample_rate_s	float | None
asset	str | None
loop_id	str | None
role	Role | None
retrieval_mode	RetrievalMode | None
quality_codes	dict[str, str] | None
quality_assumed	bool

identity instance-attribute

identity: TagIdentity

name instance-attribute

name: str

_ instance-attribute

_: KW_ONLY

unit_raw class-attribute instance-attribute

unit_raw: str | None = None

unit_canonical class-attribute instance-attribute

unit_canonical: str | None = None

eng_range class-attribute instance-attribute

eng_range: EngRange | None = None

sample_rate_s class-attribute instance-attribute

sample_rate_s: float | None = None

asset class-attribute instance-attribute

asset: str | None = None

loop_id class-attribute instance-attribute

loop_id: str | None = None

role class-attribute instance-attribute

role: Role | None = None

retrieval_mode class-attribute instance-attribute

retrieval_mode: RetrievalMode | None = None

quality_codes class-attribute instance-attribute

quality_codes: dict[str, str] | None = None

quality_assumed class-attribute instance-attribute

quality_assumed: bool = False

__post_init__

__post_init__() -> None