<!--
This file is part of libtcspc
Copyright 2019-2026 Board of Regents of the University of Wisconsin System
SPDX-License-Identifier: MIT
-->

# Auxiliary objects

These objects are used during graph definition to configure event types and
processor nodes.

## Data types

{py:class}`~libtcspc.DataTypes` objects are used to specify the numeric data
types used for timestamp and related event fields.

```{eval-rst}
.. autosummary::
   :toctree: generated
   :nosignatures:

   libtcspc.DataTypes
```

## Parameters

Various settings of processing nodes and other auxiliary objects can be left
parameterized in the graph, so that the compiled graph can be reused with
different values for those settings, supplied when creating the execution
context. The {py:class}`~libtcspc.Param` object serves as a placeholder for
parameterized values.

```{eval-rst}
.. autosummary::
   :toctree: generated
   :nosignatures:

   libtcspc.Param
```

## Access tags

Some processing nodes support direct interaction at run time. This is used, for
example, to retrieve results from nodes that collect statistics, or to control
stream behavior such as buffering. To enable such access, an
{py:class}`~libtcspc.AccessTag` is attached to the node during graph
definition; at execution time, access to the node can be obtained using the
same tag.

```{eval-rst}
.. autosummary::
   :toctree: generated
   :nosignatures:

   libtcspc.AccessTag
```

## Acquisition readers

Readers that supply data to the {py:class}`~libtcspc.Acquire` processor by
wrapping pull-style device APIs.

```{eval-rst}
.. autosummary::
   :toctree: generated
   :nosignatures:

   libtcspc.AcquisitionReader
   libtcspc.NullReader
   libtcspc.StuckReader
```

## Bucket sources

Allocation strategies for bucket instances used by processors that produce bulk
data.

```{eval-rst}
.. autosummary::
   :toctree: generated
   :nosignatures:

   libtcspc.BucketSource
   libtcspc.NewDeleteBucketSource
   libtcspc.RecyclingBucketSource
```

## Input streams

Inputs to source processor nodes such as
{py:class}`~libtcspc.ReadBinaryStream`.

```{eval-rst}
.. autosummary::
   :toctree: generated
   :nosignatures:

   libtcspc.InputStream
   libtcspc.BinaryFileInputStream
```