GNU Radio 3.7.0-50 C++ API
gr::blocks::file_sink Class Reference

Write stream to file. More...

#include <file_sink.h>

Inheritance diagram for gr::blocks::file_sink:
gr::sync_block gr::blocks::file_sink_base gr::block gr::basic_block gr::msg_accepter gr::messages::msg_accepter

Public Types

typedef boost::shared_ptr
< file_sink
sptr

Static Public Member Functions

static sptr make (size_t itemsize, const char *filename)
 Make a file sink.

Additional Inherited Members

- Public Member Functions inherited from gr::sync_block
virtual int work (int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)=0
 just like gr::block::general_work, only this arranges to call consume_each for you
void forecast (int noutput_items, gr_vector_int &ninput_items_required)
 Estimate input requirements given output request.
int general_work (int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
 compute output items from input items
int fixed_rate_ninput_to_noutput (int ninput)
 Given ninput samples, return number of output samples that will be produced. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
int fixed_rate_noutput_to_ninput (int noutput)
 Given noutput samples, return number of input samples required to produce noutput. N.B. this is only defined if fixed_rate returns true. Generally speaking, you don't need to override this.
- Public Member Functions inherited from gr::blocks::file_sink_base
 file_sink_base ()
 ~file_sink_base ()
bool open (const char *filename)
 Open filename and begin output to it.
void close ()
 Close current output file.
void do_update ()
 if we've had an update, do it now.
void set_unbuffered (bool unbuffered)
 turn on unbuffered writes for slower outputs
- Protected Types inherited from gr::basic_block
enum  vcolor { WHITE, GREY, BLACK }
- Protected Member Functions inherited from gr::sync_block
 sync_block (void)
 sync_block (const std::string &name, gr::io_signature::sptr input_signature, gr::io_signature::sptr output_signature)
- Protected Member Functions inherited from gr::blocks::file_sink_base
 file_sink_base (const char *filename, bool is_binary)
- Protected Attributes inherited from gr::block
std::vector< long > d_max_output_buffer
std::vector< long > d_min_output_buffer
gr::thread::mutex d_setlock
gr::logger_ptr d_logger
gr::logger_ptr d_debug_logger
- Protected Attributes inherited from gr::blocks::file_sink_base
FILE * d_fp
FILE * d_new_fp
bool d_updated
bool d_is_binary
boost::mutex d_mutex
bool d_unbuffered

Detailed Description

Write stream to file.

Member Typedef Documentation

Member Function Documentation

static sptr gr::blocks::file_sink::make ( size_t  itemsize,
const char *  filename 
)
static

Make a file sink.

Parameters
itemsizesize of the input data items.
filenamename of the file to open and write output to.

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