Capture Class Reference

A class for a generic IQ capture device. More...

#include <Capture.h>

Collaboration diagram for Capture:

Public Member Functions
	Capture (std::string type, uint32_t fs, uint32_t fc, std::string path)
	Constructor. More...
void	process (IqData *buffer1, IqData *buffer2)
	Implement the capture process. More...
void	set_replay (bool loop, std::string file)
	Set parameters to enable file replay. More...

Public Attributes
std::string	type
	The capture device type. More...
uint32_t	fs
	Sampling frequency (Hz). More...
uint32_t	fc
	Center frequency (Hz). More...
bool	saveIq
	True if IQ data is saved to file. More...
std::string	path
	Absolute path to IQ save location. More...

Private Attributes
bool	replay
	True if file replay is enabled. More...
bool	loop
	True if replay file should loop when complete. More...
std::string	file
	Absolute path of file to replay. More...

Static Private Attributes
static const std::string	VALID_TYPE [2] = {"RspDuo", "HackRF"}
	The valid capture devices. More...

Detailed Description

A class for a generic IQ capture device.

Author

30hours

Constructor & Destructor Documentation

Capture()

Capture::Capture	(	std::string	type,
		uint32_t	fs,
		uint32_t	fc,
		std::string	path
	)

Constructor.

Parameters

type	The capture device type.
fs	Sampling frequency (Hz).
fc	Center frequency (Hz).
path	Absolute path to IQ save location.

Returns

The object.

Member Function Documentation

process()

void Capture::process	(	IqData *	buffer1,
		IqData *	buffer2
	)

Implement the capture process.

Parameters

buffer1	Buffer for reference samples.
buffer2	Buffer for surveillance samples.

Returns

Void.

set_replay()

void Capture::set_replay	(	bool	loop,
		std::string	file
	)

Set parameters to enable file replay.

Parameters

loop	True if replay file should loop when complete.
file	Absolute path of file to replay.

Returns

Void.

Member Data Documentation

fc

uint32_t Capture::fc

Center frequency (Hz).

file

std::string Capture::file

private

Absolute path of file to replay.

fs

uint32_t Capture::fs

Sampling frequency (Hz).

loop

bool Capture::loop

private

True if replay file should loop when complete.

path

std::string Capture::path

Absolute path to IQ save location.

replay

bool Capture::replay

private

True if file replay is enabled.

saveIq

bool Capture::saveIq

True if IQ data is saved to file.

type

std::string Capture::type

The capture device type.

VALID_TYPE

const std::string Capture::VALID_TYPE = {"RspDuo", "HackRF"}

staticprivate

The valid capture devices.

---

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

• src/capture/Capture.h
• src/capture/Capture.cpp