Class Pipe
Pipes are pop-passive pipeline modules.

All Subcl's Caster, Counter, Echoer, EditEnvironment, Filter, Joiner, Namer, Sampler, Shifter, Source, Tupler
Defined in <seqan/pipe.h>
Signature template <typename TInput, typename TSpec> class Pipe;

Template Parameters

TSpec The specializing type.
TInput The type of the pipeline module this module reads from. Use Bundle2, Bundle3, etc. to read from more than one module.

Member Function Overview

Interface Function Overview

Interface Metafunction Overview

Detailed Description

Use Value to get the output type of a given Pipe (returns Value<TInput>::Type by default).

Use Size to get the size type of a given Pipe (returns Size<TInput>::Type by default).

Member Functions Detail

Pipe::Pipe(in);

Constructor

Parameters

in Reference to an input pipe.

Data Races

Thread safety unknown!

Interface Functions Detail

void assign(target, source);

Assigns one object to another object.

Parameters

target Reference to assign to.
source Value to assign.

Assign value of source to target.

Data Races

Thread safety unknown!

bool atEnd(pipe);

Check whether the Pipe object is at end.

Parameters

pipe The Pipe object to query.

Returns

bool true in case of the pipe being at the end, false otherwise.

Data Races

Thread safety unknown!

bool beginRead(object);

Initiates a read process.

Parameters

object A pop-passive pipeline module.

Returns

bool true on success, false on failure.

beginRead rewinds the output stream, prepares object for succeeding reads, and typically calls beginRead of the input pipeline modules.

A read process must be terminated with endRead. Nested read processes are not allowed.

Data Races

Thread safety unknown!

See Also

bool endRead(object);

Terminates a read process.

Parameters

object A pop-passive pipeline module.

Returns

bool true on success, false on failure.

endRead closes the output stream, frees resources possibly allocated by beginRead, and typically calls endRead of the input pipeline modules.

Data Races

Thread safety unknown!

See Also

TValue front(object);

Gets the first element of the remaining stream.

Parameters

object A pop-passive pipeline module.

Returns

TValue The first element of the remaining input stream. Return type is Value<TObject>::Type for object type TObject.

Pipe#front or Pipe#pop can only be called within a read process surrounded by beginRead and endRead.

Data Races

Thread safety unknown!

See Also

TSize length(pipe);

Length of the pipe.

Parameters

pipe The Pipe to query for its size.

Returns

TSize The size of the pipe.

Data Races

Thread safety unknown!

void pop(pipe[, ref]);

Pops the first element of the remaining stream.

Parameters

pipe A pop-passive pipeline module.
ref Reference to the result. Result type is Value<TObject>::Type for object type TObject. Returns the first element of the remaining input stream.

In contrast to Pipe#front this function also steps one element further.

Pipe#front or Pipe#pop can only be called within a read process surrounded by beginRead and endRead.

Data Races

Thread safety unknown!

Interface Metafunctions Detail

Size<TPipe>::Type;

Return size type of the Pipe specialization.

Template Parameters

TPipe The Pipe specialization to query.

Returns

Type The resulting size type.

Value<TPipe>::Type;

Return value type of the Pipe specialization.

Template Parameters

TPipe The Pipe specialization to query.

Returns

Type The resulting value type.