SHORE API
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
shore::dp_backtracer_pipe< RefIter, QryIter, Scoring, AlnBuilder > Class Template Reference

Dynamic programming alignment backtracer class. More...

Inheritance diagram for shore::dp_backtracer_pipe< RefIter, QryIter, Scoring, AlnBuilder >:
shore::pipe_facade< dp_backtracer_pipe< RefIter, QryIter, Scoring, AlnBuilder >, dp_alignment< RefIter, QryIter, Scoring >, dp_trace > shore::buffer_chain< dp_trace >

Public Member Functions

 dp_backtracer_pipe (const dp_backtracer_config &c)
 Construct dp_backtracer_pipe from config.
 
- Public Member Functions inherited from shore::pipe_facade< dp_backtracer_pipe< RefIter, QryIter, Scoring, AlnBuilder >, dp_alignment< RefIter, QryIter, Scoring >, dp_trace >
 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 dp_trace & > & sigdata ()
 
signal< void > & sigflush ()
 
slot< const dp_alignment
< RefIter, QryIter, Scoring > & > & 
slotdata ()
 
slot< void > & slotflush ()
 
slot< void > & slotfreeze ()
 
slot< void > & slotthaw ()
 
signal< void > & sigfreeze ()
 
signal< void > & sigthaw ()
 
- Public Member Functions inherited from shore::buffer_chain< dp_trace >
 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.
 

Friends

class pipeline_core_access
 

Additional Inherited Members

- Public Types inherited from shore::pipe_facade< dp_backtracer_pipe< RefIter, QryIter, Scoring, AlnBuilder >, dp_alignment< RefIter, QryIter, Scoring >, dp_trace >
typedef dp_alignment< RefIter,
QryIter, Scoring > 
append_type
 
typedef dp_trace current_type
 
- Public Types inherited from shore::buffer_chain< dp_trace >
typedef plugin< dp_traceplugin_type
 
- Protected Types inherited from shore::pipe_facade< dp_backtracer_pipe< RefIter, QryIter, Scoring, AlnBuilder >, dp_alignment< RefIter, QryIter, Scoring >, dp_trace >
typedef pipe_facade
< dp_backtracer_pipe< RefIter,
QryIter, Scoring, AlnBuilder >
, dp_alignment< RefIter,
QryIter, Scoring >, dp_trace,
false > 
facade_type
 
- Protected Member Functions inherited from shore::pipe_facade< dp_backtracer_pipe< RefIter, QryIter, Scoring, AlnBuilder >, dp_alignment< RefIter, QryIter, Scoring >, dp_trace >
void emit (const dp_trace &d)
 Called by derived classes to emit data to downstream pipeline elements. More...
 
- Protected Member Functions inherited from shore::buffer_chain< dp_trace >
bool buffer_chain_ready () const
 Check if there is an element ready to be retrieved.
 
dp_tracebuffer_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 dp_tracebuffer_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.
 
dp_tracebuffer_chain_swap (dp_trace *buf)
 Exchange the last pushed buffer with an external one. More...
 

Detailed Description

template<typename RefIter, typename QryIter = RefIter, typename Scoring = typename dp_traits<typename std::iterator_traits<RefIter>::value_type, typename std::iterator_traits<QryIter>::value_type>::scoring_type, typename AlnBuilder = typename dp_traits<typename std::iterator_traits<RefIter>::value_type, typename std::iterator_traits<QryIter>::value_type>::alignment_builder_type>
class shore::dp_backtracer_pipe< RefIter, QryIter, Scoring, AlnBuilder >

Dynamic programming alignment backtracer class.


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