GNU Radio's SATNOGS Package
gr::satnogs::sigmf_metadata Class Reference

#include <sigmf_metadata.h>

Inheritance diagram for gr::satnogs::sigmf_metadata:
gr::satnogs::metadata

Public Member Functions

 sigmf_metadata (std::string global_segment_json)
 
 ~sigmf_metadata ()
 
void transform (pmt::pmt_t &m)
 
void to_file (const std::string &filename)
 
const std::string to_sting ()
 
void append_capture_segment (uint64_t sample_start)
 
void append_capture_segment (uint64_t sample_start, uint64_t global_index, double frequency, std::string datetime)
 
void append_capture_segment (std::string capture_json)
 
void append_annotation_segment (uint64_t sample_start, uint64_t sample_count)
 
void append_annotation_segment (uint64_t sample_start, uint64_t sample_count, std::string generator, std::string comment, double freq_lower_edge, double freq_upper_edge)
 
void append_annotation_segment (std::string annotation_json)
 
sigmf::SigMF< sigmf::Global< core::DescrT, antenna::DescrT, ::satnogs::DescrT >, sigmf::Capture< core::DescrT >, sigmf::Annotation< core::DescrT, antenna::DescrT, ::satnogs::DescrT > > & get_sigmf ()
 

Static Public Member Functions

static metadata::metadata_sptr make (const std::string global_segment_json)
 

Additional Inherited Members

Detailed Description

The sigMF implementation of gr-satnogs metadata

Constructor & Destructor Documentation

◆ sigmf_metadata()

gr::satnogs::sigmf_metadata::sigmf_metadata ( std::string  global_segment_json)

◆ ~sigmf_metadata()

gr::satnogs::sigmf_metadata::~sigmf_metadata ( )

Member Function Documentation

◆ append_annotation_segment() [1/3]

void gr::satnogs::sigmf_metadata::append_annotation_segment ( std::string  annotation_json)

◆ append_annotation_segment() [2/3]

void gr::satnogs::sigmf_metadata::append_annotation_segment ( uint64_t  sample_start,
uint64_t  sample_count 
)

◆ append_annotation_segment() [3/3]

void gr::satnogs::sigmf_metadata::append_annotation_segment ( uint64_t  sample_start,
uint64_t  sample_count,
std::string  generator,
std::string  comment,
double  freq_lower_edge,
double  freq_upper_edge 
)

◆ append_capture_segment() [1/3]

void gr::satnogs::sigmf_metadata::append_capture_segment ( std::string  capture_json)

◆ append_capture_segment() [2/3]

void gr::satnogs::sigmf_metadata::append_capture_segment ( uint64_t  sample_start)

◆ append_capture_segment() [3/3]

void gr::satnogs::sigmf_metadata::append_capture_segment ( uint64_t  sample_start,
uint64_t  global_index,
double  frequency,
std::string  datetime 
)

◆ get_sigmf()

sigmf::SigMF< sigmf::Global< core::DescrT, antenna::DescrT, ::satnogs::DescrT >, sigmf::Capture< core::DescrT >, sigmf::Annotation< core::DescrT, antenna::DescrT, ::satnogs::DescrT > > & gr::satnogs::sigmf_metadata::get_sigmf ( )

◆ make()

static metadata::metadata_sptr gr::satnogs::sigmf_metadata::make ( const std::string  global_segment_json)
static

◆ to_file()

void gr::satnogs::sigmf_metadata::to_file ( const std::string &  filename)
virtual

Stores to file the metadata. The form of the data depends on the implementation

Parameters
filenamethe full path to the metadata file

Implements gr::satnogs::metadata.

◆ to_sting()

const std::string gr::satnogs::sigmf_metadata::to_sting ( )
virtual
Returns
string representation of the processed metadata

Implements gr::satnogs::metadata.

◆ transform()

void gr::satnogs::sigmf_metadata::transform ( pmt::pmt_t &  m)
virtual

Transforms the PMT metadata message of gr-satnogs to the appropriate form. The form and the storage is implementation specific

Parameters
mthe message containing a dictionary of gr-satnogs matadata

Implements gr::satnogs::metadata.


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