Class PointAndCargo
Simple record class storing a point (one-value) interval and cargo.

Defined in <seqan/misc/interval_tree.h>
Signature template <[typename TValue[, typename TCargo]]> class PointAndCargo;

Template Parameters

TValue The value type.
TCargo The cargo type.

Member Function Overview

Interface Function Overview

Interface Metafunction Overview

Member Variable Overview

Member Functions Detail

PointAndCargo::PointAndCargo(); PointAndCargo::PointAndCargo(point, cargo);

Constructor

Parameters

point The point to store.
cargo The cargo to store.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

Interface Functions Detail

TCargo cargo(point);

Access to the cargo.

Parameters

point The PointAndCargo to query for its cargo.

Returns

TCargo Reference to the cargo member.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TCargo getCargo(point);

Access to the cargo.

Parameters

point The PointAndCargo to query for its cargo.

Returns

TCargo Copy of the cargo member.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TBoundary getLeftBoundary(point);

Access to getLeft boundary.

Parameters

point The PointAndCargo to query for its left boundary.

Returns

TBoundary Copy of the left boundary value.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TBoundary leftBoundary(point);

Access to left boundary.

Parameters

point The PointAndCargo to query for its left boundary.

Returns

TBoundary Reference to the left boundary value.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

TBoundary rightBoundary(point);

Access to right boundary.

Parameters

point The PointAndCargo to query for its right boundary.

Returns

TBoundary Reference to the right boundary value.

Data Races

If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.

Interface Metafunctions Detail

Cargo<TPointAndCargo>::Type;

Return the cargo type.

Value<TPointAndCargo>::Type;

Return the value type.

Member Variables Detail

TCargo PointAndCargo::cargo

The cargo to store.

TValue PointAndCargo::point

The point to store.