GNU Radio 3.7.3 C++ API
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
gr::io_signature Class Reference

i/o signature for input and output ports. More...

#include <gnuradio/io_signature.h>

Public Types

typedef boost::shared_ptr
< io_signature > 		sptr
 

Public Member Functions

 ~io_signature ()
 
int min_streams () const
 
int max_streams () const
 
int sizeof_stream_item (int index) const
 
std::vector< int > sizeof_stream_items () const
 

Static Public Member Functions

static sptr make (int min_streams, int max_streams, int sizeof_stream_item)
 Create an i/o signature. More...
 
static sptr make2 (int min_streams, int max_streams, int sizeof_stream_item1, int sizeof_stream_item2)
 Create an i/o signature. More...
 
static sptr make3 (int min_streams, int max_streams, int sizeof_stream_item1, int sizeof_stream_item2, int sizeof_stream_item3)
 Create an i/o signature. More...
 
static sptr makev (int min_streams, int max_streams, const std::vector< int > &sizeof_stream_items)
 Create an i/o signature. More...
 

Static Public Attributes

static const int IO_INFINITE = -1
 

Detailed Description

i/o signature for input and output ports.

misc

Member Typedef Documentation

typedef boost::shared_ptr<io_signature> gr::io_signature::sptr

Constructor & Destructor Documentation

gr::io_signature::~io_signature ( )

Member Function Documentation

static sptr gr::io_signature::make2 ( int  min_streams,
int  max_streams,
int  sizeof_stream_item1,
int  sizeof_stream_item2 
)
static

Create an i/o signature.

Parameters
min_streamsspecify minimum number of streams (>= 0)
max_streamsspecify maximum number of streams (>= min_streams or -1 -> infinite)
sizeof_stream_item1specify the size of the items in the first stream
sizeof_stream_item2specify the size of the items in the second and subsequent streams
static sptr gr::io_signature::make3 ( int  min_streams,
int  max_streams,
int  sizeof_stream_item1,
int  sizeof_stream_item2,
int  sizeof_stream_item3 
)
static

Create an i/o signature.

Parameters
min_streamsspecify minimum number of streams (>= 0)
max_streamsspecify maximum number of streams (>= min_streams or -1 -> infinite)
sizeof_stream_item1specify the size of the items in the first stream
sizeof_stream_item2specify the size of the items in the second stream
sizeof_stream_item3specify the size of the items in the third and subsequent streams
static sptr gr::io_signature::makev ( int  min_streams,
int  max_streams,
const std::vector< int > &  sizeof_stream_items 
)
static

Create an i/o signature.

Parameters
min_streamsspecify minimum number of streams (>= 0)
max_streamsspecify maximum number of streams (>= min_streams or -1 -> infinite)
sizeof_stream_itemsspecify the size of the items in the streams

If there are more streams than there are entries in sizeof_stream_items, the value of the last entry in sizeof_stream_items is used for the missing values. sizeof_stream_items must contain at least 1 entry.

int gr::io_signature::max_streams ( ) const
inline
int gr::io_signature::min_streams ( ) const
inline
int gr::io_signature::sizeof_stream_item ( int  index) const
std::vector<int> gr::io_signature::sizeof_stream_items ( ) const

Member Data Documentation

const int gr::io_signature::IO_INFINITE = -1
static
The documentation for this class was generated from the following file: