SHORE API
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
shore::sff_flatten_pipe Class Reference

Convert SFF file records obtained from sff_reader into regular raw read records. More...

Inheritance diagram for shore::sff_flatten_pipe:
shore::pipe_facade< sff_flatten_pipe, sff_read, read > shore::buffer_chain< read >

Friends

class shore::pipeline_core_access
 

Additional Inherited Members

- Public Types inherited from shore::pipe_facade< sff_flatten_pipe, sff_read, read >
typedef sff_read append_type
 
typedef read current_type
 
- Public Types inherited from shore::buffer_chain< read >
typedef plugin< readplugin_type
 
- Public Member Functions inherited from shore::pipe_facade< sff_flatten_pipe, sff_read, read >
 pipe_facade (const pipe_facade &t)
 Copy constructor: need to bind the slots to the correct object.
 
void disconnect_inputs ()
 Disconnect all connected upstream pipeline elements.
 
void disconnect_outputs ()
 Disconnect all connected downstream pipeline elements.
 
signal< const read & > & sigdata ()
 
signal< void > & sigflush ()
 
slot< const sff_read & > & slotdata ()
 
slot< void > & slotflush ()
 
slot< void > & slotfreeze ()
 
slot< void > & slotthaw ()
 
signal< void > & sigfreeze ()
 
signal< void > & sigthaw ()
 
- Public Member Functions inherited from shore::buffer_chain< read >
 buffer_chain ()
 Constructor - initialize empty buffer chain.
 
 ~buffer_chain ()
 Destructor - free all buffers.
 
void add_plugin (plugin_type *const p)
 Add a plugin object.
 
void clear_plugins ()
 Remove all plugin objects.
 
- Protected Types inherited from shore::pipe_facade< sff_flatten_pipe, sff_read, read >
typedef pipe_facade
< sff_flatten_pipe, sff_read,
read, false > 
facade_type
 
- Protected Member Functions inherited from shore::pipe_facade< sff_flatten_pipe, sff_read, read >
void emit (const read &d)
 Called by derived classes to emit data to downstream pipeline elements. More...
 
- Protected Member Functions inherited from shore::buffer_chain< read >
bool buffer_chain_ready () const
 Check if there is an element ready to be retrieved.
 
readbuffer_chain_push ()
 Get an empty buffer.
 
bool buffer_chain_prepare ()
 Apply plugins after having initialized a new buffer.
 
bool buffer_chain_flush (const bool undo_last_push)
 Indicate that no more data will be added. More...
 
const readbuffer_chain_front () const
 Get the contents of the first buffer.
 
bool buffer_chain_waiting () const
 Check that the buffer chain is neither ready nor flushed.
 
bool buffer_chain_pop ()
 Discard the buffer holding the first element.
 
void buffer_chain_reset ()
 Clear all data and reset the state of the buffer chain.
 
readbuffer_chain_swap (read *buf)
 Exchange the last pushed buffer with an external one. More...
 

Detailed Description

Convert SFF file records obtained from sff_reader into regular raw read records.


The documentation for this class was generated from the following file: