GNU Radio Manual and C++ API Reference  3.10.9.1
The Free & Open Software Radio Ecosystem
gr::tag_t Struct Reference

#include <gnuradio/tags.h>

Public Member Functions

bool operator== (const tag_t &t) const
 equality comparison. Compares all details, except marked_delete More...
 
 tag_t ()
 
 tag_t (const tag_t &rhs)
 Copy constructor; constructs identical tag, but doesn't copy marked_delete. More...
 
tag_toperator= (const tag_t &rhs)
 
 ~tag_t ()
 

Static Public Member Functions

static bool offset_compare (const tag_t &x, const tag_t &y)
 Comparison function to test which tag, x or y, came first in time. More...
 

Public Attributes

uint64_t offset
 the item tag occurred at (as a uint64_t) More...
 
pmt::pmt_t key
 the key of tag (as a PMT symbol) More...
 
pmt::pmt_t value
 the value of tag (as a PMT) More...
 
pmt::pmt_t srcid
 the source ID of tag (as a PMT) More...
 
std::vector< long > marked_deleted
 Used by gr_buffer to mark a tagged as deleted by a specific block. You can usually ignore this. More...
 

Friends

bool operator< (const tag_t &x, const tag_t &y)
 Comparison function to test which tag, x or y, came first in time. More...
 

Constructor & Destructor Documentation

◆ tag_t() [1/2]

gr::tag_t::tag_t ( )
inline

◆ tag_t() [2/2]

gr::tag_t::tag_t ( const tag_t rhs)
inline

Copy constructor; constructs identical tag, but doesn't copy marked_delete.

◆ ~tag_t()

gr::tag_t::~tag_t ( )
inline

Member Function Documentation

◆ offset_compare()

static bool gr::tag_t::offset_compare ( const tag_t x,
const tag_t y 
)
inlinestatic

Comparison function to test which tag, x or y, came first in time.

◆ operator=()

tag_t& gr::tag_t::operator= ( const tag_t rhs)
inline

References key, offset, srcid, and value.

◆ operator==()

bool gr::tag_t::operator== ( const tag_t t) const
inline

equality comparison. Compares all details, except marked_delete

References key, offset, srcid, and value.

Friends And Related Function Documentation

◆ operator<

bool operator< ( const tag_t x,
const tag_t y 
)
friend

Comparison function to test which tag, x or y, came first in time.

Member Data Documentation

◆ key

pmt::pmt_t gr::tag_t::key

the key of tag (as a PMT symbol)

Referenced by gr::block::add_item_tag(), operator=(), operator==(), and gr::block::remove_item_tag().

◆ marked_deleted

std::vector<long> gr::tag_t::marked_deleted

Used by gr_buffer to mark a tagged as deleted by a specific block. You can usually ignore this.

◆ offset

uint64_t gr::tag_t::offset

the item tag occurred at (as a uint64_t)

Referenced by gr::block::add_item_tag(), operator=(), operator==(), and gr::block::remove_item_tag().

◆ srcid

pmt::pmt_t gr::tag_t::srcid

the source ID of tag (as a PMT)

Referenced by gr::block::add_item_tag(), operator=(), operator==(), and gr::block::remove_item_tag().

◆ value

pmt::pmt_t gr::tag_t::value

the value of tag (as a PMT)

Referenced by gr::block::add_item_tag(), operator=(), operator==(), and gr::block::remove_item_tag().


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