1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
//
// Copyright 2012 Josh Blum
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program 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 Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with io_sig program. If not, see <http://www.gnu.org/licenses/>.
#ifndef INCLUDED_GNURADIO_BLOCK_HPP
#define INCLUDED_GNURADIO_BLOCK_HPP
#include <gnuradio/runtime_api.h>
#include <gnuradio/element.hpp>
#include <gnuradio/tags.hpp>
#include <gruel/pmt.h>
#include <vector>
#include <string>
namespace gnuradio
{
template <typename PtrType> struct Buffer
{
//! get a native pointer type to this buffer
inline PtrType get(void) const
{
return _mem;
}
//! get a pointer of the desired type to this buffer
template <typename T> inline T cast(void) const
{
return reinterpret_cast<T>(this->get());
}
//! get the number of items in this buffer
inline size_t size(void) const
{
return _len;
}
//private:
PtrType _mem;
size_t _len;
};
struct GR_RUNTIME_API Block : Element
{
enum
{
WORK_CALLED_PRODUCE = -2,
WORK_DONE = -1
};
enum tag_propagation_policy_t
{
TPP_DONT = 0,
TPP_ALL_TO_ALL = 1,
TPP_ONE_TO_ONE = 2
};
Block(void);
Block(const std::string &name);
/*******************************************************************
* Basic routines from basic block
******************************************************************/
size_t history(const size_t which_input = 0) const;
void set_history(const size_t history, const size_t which_input = 0);
void set_output_multiple(const size_t multiple, const size_t which_output = 0);
size_t output_multiple(const size_t which_output = 0) const;
void consume(const size_t which_input, const size_t how_many_items);
void consume_each(const size_t how_many_items);
void produce(const size_t which_output, const size_t how_many_items);
/*!
* Enable fixed rate logic.
* When enabled, relative rate is assumed to be set,
* and forecast is automatically called.
* Also, consume will be called automatically.
*/
void set_fixed_rate(const bool fixed_rate);
/*!
* The relative rate can be thought of as interpolation/decimation.
* In other words, relative rate is the ratio of output items to input items.
*/
void set_relative_rate(double relative_rate);
double relative_rate(void) const;
/*******************************************************************
* Tag related routines from basic block
******************************************************************/
uint64_t nitems_read(const size_t which_input);
uint64_t nitems_written(const size_t which_output);
tag_propagation_policy_t tag_propagation_policy(void);
void set_tag_propagation_policy(tag_propagation_policy_t p);
void add_item_tag(
const size_t which_output, const Tag &tag
);
void add_item_tag(
const size_t which_output,
uint64_t abs_offset,
const pmt::pmt_t &key,
const pmt::pmt_t &value,
const pmt::pmt_t &srcid=pmt::PMT_F
);
void get_tags_in_range(
std::vector<Tag> &tags,
const size_t which_input,
uint64_t abs_start,
uint64_t abs_end
);
void get_tags_in_range(
std::vector<Tag> &tags,
const size_t which_input,
uint64_t abs_start,
uint64_t abs_end,
const pmt::pmt_t &key
);
/*******************************************************************
* Work related routines from basic block
******************************************************************/
//! Called when the flow graph is started, can overload
virtual bool start(void);
//! Called when the flow graph is stopped, can overload
virtual bool stop(void);
typedef std::vector<Buffer<const void *> > InputItems;
typedef std::vector<Buffer<void *> > OutputItems;
//! The official call into the work routine (overload please)
virtual int work(
const InputItems &input_items,
const OutputItems &output_items
) = 0;
//! forcast requirements, can be overloaded
virtual void forecast(
int noutput_items,
std::vector<size_t> &ninput_items_required
);
};
} //namespace gnuradio
#endif /*INCLUDED_GNURADIO_BLOCK_HPP*/
|
