GNU Radio Manual and C++ API Reference  3.7.13.4
The Free & Open Software Radio Ecosystem
Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | List of all members
plinfo Class Reference

pipeline info that flows with data More...

#include <gnuradio/atsc/types.h>

Public Member Functions

 plinfo ()
 
bool field_sync1_p () const
 
bool field_sync2_p () const
 
bool field_sync_p () const
 
bool regular_seg_p () const
 
bool in_field1_p () const
 
bool in_field2_p () const
 
bool first_regular_seg_p () const
 
bool transport_error_p () const
 
unsigned int segno () const
 
unsigned int flags () const
 
void set_field_sync1 ()
 
void set_field_sync2 ()
 
void set_regular_seg (bool field2, int segno)
 
void set_transport_error (bool error)
 
bool operator== (const plinfo &other) const
 
bool operator!= (const plinfo &other) const
 

Static Public Member Functions

static void delay (plinfo &out, const plinfo &in, int nsegs_of_delay)
 
static void sanity_check (const plinfo &in)
 

Protected Attributes

unsigned short _flags
 
unsigned short _segno
 

Static Protected Attributes

static const int fl_regular_seg = 0x0001
 
static const int fl_field_sync1 = 0x0002
 
static const int fl_field_sync2 = 0x0004
 
static const int fl_first_regular_seg = 0x0008
 
static const int fl_field2 = 0x0010
 
static const int fl_transport_error = 0x0020
 

Detailed Description

pipeline info that flows with data

Not all modules need all the info

Constructor & Destructor Documentation

plinfo::plinfo ( )
inline

Member Function Documentation

static void plinfo::delay ( plinfo &  out,
const plinfo &  in,
int  nsegs_of_delay 
)
static

Set OUT such that it reflects a NSEGS_OF_DELAY pipeline delay from IN.

Referenced by operator!=().

bool plinfo::field_sync1_p ( ) const
inline

References _flags, and fl_field_sync1.

Referenced by field_sync_p().

bool plinfo::field_sync2_p ( ) const
inline

References _flags, and fl_field_sync2.

Referenced by field_sync_p().

bool plinfo::field_sync_p ( ) const
inline

References field_sync1_p(), and field_sync2_p().

bool plinfo::first_regular_seg_p ( ) const
inline

References _flags, and fl_first_regular_seg.

unsigned int plinfo::flags ( ) const
inline

References _flags.

bool plinfo::in_field1_p ( ) const
inline

References _flags, and fl_field2.

bool plinfo::in_field2_p ( ) const
inline

References _flags, and fl_field2.

bool plinfo::operator!= ( const plinfo &  other) const
inline

References _flags, _segno, delay(), and sanity_check().

bool plinfo::operator== ( const plinfo &  other) const
inline

References _flags, and _segno.

bool plinfo::regular_seg_p ( ) const
inline

References _flags, and fl_regular_seg.

static void plinfo::sanity_check ( const plinfo &  in)
static

confirm that X is plausible

Referenced by operator!=().

unsigned int plinfo::segno ( ) const
inline

References _segno.

Referenced by set_regular_seg().

void plinfo::set_field_sync1 ( )
inline

References _flags, _segno, and fl_field_sync1.

void plinfo::set_field_sync2 ( )
inline

References _flags, _segno, fl_field2, and fl_field_sync2.

void plinfo::set_regular_seg ( bool  field2,
int  segno 
)
inline

References _flags, _segno, ATSC_DSEGS_PER_FIELD, fl_field2, fl_first_regular_seg, fl_regular_seg, fl_transport_error, and segno().

void plinfo::set_transport_error ( bool  error)
inline

References _flags, and fl_transport_error.

bool plinfo::transport_error_p ( ) const
inline

References _flags, and fl_transport_error.

Member Data Documentation

unsigned short plinfo::_flags
protected

Referenced by field_sync1_p(), field_sync2_p(), first_regular_seg_p(), flags(), in_field1_p(), in_field2_p(), operator!=(), operator==(), regular_seg_p(), set_field_sync1(), set_field_sync2(), set_regular_seg(), set_transport_error(), and transport_error_p().

unsigned short plinfo::_segno
protected

Referenced by operator!=(), operator==(), segno(), set_field_sync1(), set_field_sync2(), and set_regular_seg().

const int plinfo::fl_field2 = 0x0010
staticprotected

Referenced by in_field1_p(), in_field2_p(), set_field_sync2(), and set_regular_seg().

const int plinfo::fl_field_sync1 = 0x0002
staticprotected

Referenced by field_sync1_p(), and set_field_sync1().

const int plinfo::fl_field_sync2 = 0x0004
staticprotected

Referenced by field_sync2_p(), and set_field_sync2().

const int plinfo::fl_first_regular_seg = 0x0008
staticprotected

Referenced by first_regular_seg_p(), and set_regular_seg().

const int plinfo::fl_regular_seg = 0x0001
staticprotected

Referenced by regular_seg_p(), and set_regular_seg().

const int plinfo::fl_transport_error = 0x0020
staticprotected

Referenced by set_regular_seg(), set_transport_error(), and transport_error_p().

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