gr-baz Package
baz_pow_cc.h
Go to the documentation of this file.
1/* -*- c++ -*- */
2/*
3 * Copyright 2004 Free Software Foundation, Inc.
4 *
5 * This file is part of GNU Radio
6 *
7 * GNU Radio is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 3, or (at your option)
10 * any later version.
11 *
12 * GNU Radio is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with GNU Radio; see the file COPYING. If not, write to
19 * the Free Software Foundation, Inc., 51 Franklin Street,
20 * Boston, MA 02110-1301, USA.
21 */
22
23/*
24 * gr-baz by Balint Seeber (http://spench.net/contact)
25 * Information, documentation & samples: http://wiki.spench.net/wiki/gr-baz
26 */
27
28#ifndef INCLUDED_BAZ_POW_CC_H
29#define INCLUDED_BAZ_POW_CC_H
30
31#include <gnuradio/sync_block.h>
32
34
35/*
36 * We use boost::shared_ptr's instead of raw pointers for all access
37 * to gr::blocks (and many other data structures). The shared_ptr gets
38 * us transparent reference counting, which greatly simplifies storage
39 * management issues. This is especially helpful in our hybrid
40 * C++ / Python system.
41 *
42 * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
43 *
44 * As a convention, the _sptr suffix indicates a boost::shared_ptr
45 */
46typedef boost::shared_ptr<baz_pow_cc> baz_pow_cc_sptr;
47
48/*!
49 * \brief Return a shared_ptr to a new instance of baz_pow_cc.
50 *
51 * To avoid accidental use of raw pointers, baz_pow_cc's
52 * constructor is private. howto_make_square2_ff is the public
53 * interface for creating new instances.
54 */
55BAZ_API baz_pow_cc_sptr baz_make_pow_cc (float exponent, float div_exp = 0.0);
56
57/*!
58 * \brief square2 a stream of floats.
59 * \ingroup block
60 *
61 * This uses the preferred technique: subclassing gr::sync_block.
62 */
63class BAZ_API baz_pow_cc : public gr::sync_block
64{
65private:
66 // The friend declaration allows howto_make_square2_ff to
67 // access the private constructor.
68
69 friend BAZ_API baz_pow_cc_sptr baz_make_pow_cc (float exponent, float div_exp);
70
71 baz_pow_cc (float exponent, float div_exp = 0.0); // private constructor
72
73 float d_exponent;
74 float d_div_exp;
75
76 public:
77 ~baz_pow_cc (); // public destructor
78
79 void set_exponent(float exponent);
80 void set_division_exponent(float div_exp);
81
82 inline float exponent() const
83 { return d_exponent; }
84 inline float division_exponent() const
85 { return d_div_exp; }
86
87 int work (int noutput_items,
88 gr_vector_const_void_star &input_items,
89 gr_vector_void_star &output_items);
90};
91
92#endif /* INCLUDED_BAZ_POW_CC_H */
#define BAZ_API
Definition: api.h:19
class BAZ_API baz_pow_cc
Definition: baz_pow_cc.h:33
BAZ_API baz_pow_cc_sptr baz_make_pow_cc(float exponent, float div_exp=0.0)
Return a shared_ptr to a new instance of baz_pow_cc.
square2 a stream of floats.
Definition: baz_pow_cc.h:64
friend BAZ_API baz_pow_cc_sptr baz_make_pow_cc(float exponent, float div_exp)
Return a shared_ptr to a new instance of baz_pow_cc.
void set_division_exponent(float div_exp)
float division_exponent() const
Definition: baz_pow_cc.h:84
float exponent() const
Definition: baz_pow_cc.h:82
int work(int noutput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items)
void set_exponent(float exponent)