gr::satnogs::sigmf_metadata Class Reference

#include <sigmf_metadata.h>

Inheritance diagram for gr::satnogs::sigmf_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 ()
Public Member Functions inherited from gr::satnogs::metadata
virtual void	transform (pmt::pmt_t &m)=0
virtual void	to_file (const std::string &filename)=0
virtual const std::string	to_sting ()=0
virtual	~metadata ()

Static Public Member Functions
static metadata::metadata_sptr	make (const std::string global_segment_json)
Static Public Member Functions inherited from gr::satnogs::metadata
static std::string	value (const key_t &k)
static std::string	keys ()
static std::string	time_iso8601 ()
static void	add_time_iso8601 (pmt::pmt_t &m)
static void	add_pdu (pmt::pmt_t &m, const uint8_t *in, size_t len)
static void	add_crc_valid (pmt::pmt_t &m, bool valid)
static void	add_sample_start (pmt::pmt_t &m, uint64_t idx)
static void	add_sample_cnt (pmt::pmt_t &m, uint64_t cnt)
static void	add_symbol_erasures (pmt::pmt_t &m, uint32_t cnt)
static void	add_corrected_bits (pmt::pmt_t &m, uint32_t cnt)
static void	add_center_freq (pmt::pmt_t &m, double offset)
static void	add_freq_offset (pmt::pmt_t &m, double offset)
static void	add_snr (pmt::pmt_t &m, float snr)
static void	add_decoder (pmt::pmt_t &m, const std::string &name, const std::string &version)
static void	add_decoder (pmt::pmt_t &m, const decoder *dec)
static void	add_antenna_azimuth (pmt::pmt_t &m, double azimuth)
static void	add_antenna_elevation (pmt::pmt_t &m, double elevation)
static void	add_antenna_polarization (pmt::pmt_t &m, std::string polarization)
static void	add_phase_delay (pmt::pmt_t &m, uint64_t phase)
static void	add_resampling_ratio (pmt::pmt_t &m, float ratio)
static void	add_symbol_timing_error (pmt::pmt_t &m, double error)
static nlohmann::json	to_json (const pmt::pmt_t &m)

Additional Inherited Members
Public Types inherited from gr::satnogs::metadata
enum	key {   PDU = 0 , DECODER_CRC_VALID , CENTER_FREQ , DECODER_PHASE_DELAY ,   DECODER_RESAMPLING_RATIO , CRC_VALID , FREQ_OFFSET , DECODER_CORRECTED_BITS ,   TIME , SAMPLE_START , SAMPLE_CNT , DECODER_SYMBOL_ERASURES ,   SNR , DECODER_NAME , DECODER_VERSION , ANTENNA_AZIMUTH ,   ANTENNA_ELEVATION , ANTENNA_POLARIZATION , SYMBOL_TIMING_ERROR , KEYS_NUM }
typedef enum gr::satnogs::metadata::key	key_t

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

filename

the 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

m	the message containing a dictionary of gr-satnogs matadata

Implements gr::satnogs::metadata.

---

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

• sigmf_metadata.h