baz_block_status.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2004,2013 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
/*
* gr-baz by Balint Seeber (http://spench.net/contact)
* Information, documentation & samples: http://wiki.spench.net/wiki/gr-baz
*/
#ifndef INCLUDED_BAZ_BLOCK_STATUS_H
#define INCLUDED_BAZ_BLOCK_STATUS_H
#include <gnuradio/sync_block.h>
#include <gnuradio/msg_queue.h>
class BAZ_API baz_block_status;
/*
* We use boost::shared_ptr's instead of raw pointers for all access
* to gr::blocks (and many other data structures). The shared_ptr gets
* us transparent reference counting, which greatly simplifies storage
* management issues. This is especially helpful in our hybrid
* C++ / Python system.
*
* See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
*
* As a convention, the _sptr suffix indicates a boost::shared_ptr
*/
typedef boost::shared_ptr<baz_block_status> baz_block_status_sptr;
/*!
* \brief Return a shared_ptr to a new instance of baz_block_status.
*
* To avoid accidental use of raw pointers, baz_block_status's
* constructor is private. howto_make_square2_ff is the public
* interface for creating new instances.
*/
BAZ_API baz_block_status_sptr baz_make_block_status (int size, unsigned long work_iterations, unsigned long samples_processed, gr::msg_queue::sptr queue = gr::msg_queue::sptr());
/*!
* \brief square2 a stream of floats.
* \ingroup block
*
* This uses the preferred technique: subclassing gr::sync_block.
*/
class BAZ_API baz_block_status : public gr::sync_block
{
private:
// The friend declaration allows howto_make_square2_ff to
// access the private constructor.
friend BAZ_API baz_block_status_sptr baz_make_block_status (int size, unsigned long work_iterations, unsigned long samples_processed, gr::msg_queue::sptr queue);
baz_block_status (int size, gr::msg_queue::sptr queue, unsigned long work_iterations, unsigned long samples_processed); // private constructor
int d_size;
gr::msg_queue::sptr d_queue;
unsigned long d_work_iterations;
unsigned long d_samples_processed;
public:
~baz_block_status (); // public destructor
void set_size(int size);
inline int size() const
{ return d_size; }
int work (int noutput_items,
gr_vector_const_void_star &input_items,
gr_vector_void_star &output_items);
};
#endif /* INCLUDED_BAZ_BLOCK_STATUS_H */
BAZ_API
#define BAZ_API
Definition: api.h:19
baz_make_block_status
BAZ_API baz_block_status_sptr baz_make_block_status(int size, unsigned long work_iterations, unsigned long samples_processed, gr::msg_queue::sptr queue=gr::msg_queue::sptr())
Return a shared_ptr to a new instance of baz_block_status.
baz_block_status
class BAZ_API baz_block_status
Definition: baz_block_status.h:34
baz_block_status
square2 a stream of floats.
Definition: baz_block_status.h:65
baz_block_status::~baz_block_status
~baz_block_status()
baz_block_status::work
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
baz_block_status::size
int size() const
Definition: baz_block_status.h:84
baz_block_status::baz_make_block_status
friend BAZ_API baz_block_status_sptr baz_make_block_status(int size, unsigned long work_iterations, unsigned long samples_processed, gr::msg_queue::sptr queue)
Return a shared_ptr to a new instance of baz_block_status.
baz_block_status::set_size
void set_size(int size)