ts::HiDesDevice Class Reference

Encapsulation of a HiDes modulator device. More...

#include <tsHiDesDevice.h>

Public Member Functions
	HiDesDevice ()
	Constructor.
virtual	~HiDesDevice ()
	Destructor.
bool	close (Report &report=(ts::CerrReport::Instance()))
	Close the device.
bool	getGain (int &gain, Report &report=(ts::CerrReport::Instance()))
	Get the output gain in dB.
bool	getGainRange (int &minGain, int &maxGain, uint64_t frequency, BandWidth bandwidth, Report &report=(ts::CerrReport::Instance()))
	Get the allowed range of output gain in dB.
bool	getInfo (HiDesDeviceInfo &info, Report &report=(ts::CerrReport::Instance())) const
	Get information about the device.
bool	isOpen () const
	Check if the HiDes device is open.
bool	open (const UString &name, Report &report=(ts::CerrReport::Instance()))
	Open the HiDes device by adapter name or device name.
bool	open (int index, Report &report=(ts::CerrReport::Instance()))
	Open the HiDes device by adapter number.
bool	send (const TSPacket *data, size_t packet_count, Report &report=(ts::CerrReport::Instance()), AbortInterface *abort=nullptr)
	Send TS packets.
bool	setDCCalibration (int dcI, int dcQ, Report &report=(ts::CerrReport::Instance()))
	Set DC calibration values.
bool	setGain (int &gain, Report &report=(ts::CerrReport::Instance()))
	Set the output gain in dB.
bool	startTransmission (Report &report=(ts::CerrReport::Instance()))
	Start transmission (after having set tuning parameters).
bool	stopTransmission (Report &report=(ts::CerrReport::Instance()))
	Stop transmission.
bool	tune (const ModulationArgs &params, Report &report=(ts::CerrReport::Instance()))
	Tune the modulator with DVB-T modulation parameters.

Static Public Member Functions
static bool	GetAllDevices (HiDesDeviceInfoList &devices, Report &report=(ts::CerrReport::Instance()))
	Get all HiDes devices in the system.

Static Public Attributes
static const int	IT95X_DC_CAL_MAX = 512
	Maximum DC calibration value.
static const int	IT95X_DC_CAL_MIN = -512
	Minimum DC calibration value.

Detailed Description

Encapsulation of a HiDes modulator device.

Member Function Documentation

GetAllDevices()

static bool ts::HiDesDevice::GetAllDevices ( HiDesDeviceInfoList &  devices, Report &  report = (ts::CerrReport::Instance())  )

static

Get all HiDes devices in the system.

Parameters

[out]	devices	Returned list of devices.
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

open() [1/2]

bool ts::HiDesDevice::open	(	int	index,
		Report &	report = (ts::CerrReport::Instance())
	)

Open the HiDes device by adapter number.

Parameters

[in]	index	Adapter number.
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

open() [2/2]

bool ts::HiDesDevice::open	(	const UString &	name,
		Report &	report = (ts::CerrReport::Instance())
	)

Open the HiDes device by adapter name or device name.

Parameters

[in]	name	Adapter name or device name.
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

isOpen()

bool ts::HiDesDevice::isOpen ( ) const

inline

Check if the HiDes device is open.

Returns

True if the HiDes device is open.

getInfo()

bool ts::HiDesDevice::getInfo	(	HiDesDeviceInfo &	info,
		Report &	report = (ts::CerrReport::Instance())
	)		const

Get information about the device.

Parameters

[out]	info	Returned information.
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

close()

bool ts::HiDesDevice::close

(

Report &

report = (ts::CerrReport::Instance())

)

Close the device.

Parameters

[in,out]

report

Where to report errors.

Returns

True on success, false on error.

setGain()

bool ts::HiDesDevice::setGain	(	int &	gain,
		Report &	report = (ts::CerrReport::Instance())
	)

Set the output gain in dB.

Parameters

[in,out]	gain	The gain (if positive) or attenuation (if negative) in dB. Upon return, gain contains the actually set value. The range of valid gain values depends on the frequency and the bandwidth.
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

See also

getGainRange()

getGain()

bool ts::HiDesDevice::getGain	(	int &	gain,
		Report &	report = (ts::CerrReport::Instance())
	)

Get the output gain in dB.

Parameters

[out]	gain	The gain (if positive) or attenuation (if negative) in dB.
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

getGainRange()

bool ts::HiDesDevice::getGainRange	(	int &	minGain,
		int &	maxGain,
		uint64_t	frequency,
		BandWidth	bandwidth,
		Report &	report = (ts::CerrReport::Instance())
	)

Get the allowed range of output gain in dB.

The range of valid gain values depends on the frequency and the bandwidth.

Parameters

[out]	minGain	Minimum allowed gain value in dB.
[out]	maxGain	Maximum allowed gain value in dB.
[in]	frequency	Target frequency in Hz.
[in]	bandwidth	Target bandwidth.
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

setDCCalibration()

bool ts::HiDesDevice::setDCCalibration	(	int	dcI,
		int	dcQ,
		Report &	report = (ts::CerrReport::Instance())
	)

Set DC calibration values.

Parameters

[in]	dcI	DC offset compensation for I (-512 to +512).
[in]	dcQ	DC offset compensation for Q (-512 to +512).
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

tune()

bool ts::HiDesDevice::tune	(	const ModulationArgs &	params,
		Report &	report = (ts::CerrReport::Instance())
	)

Tune the modulator with DVB-T modulation parameters.

Parameters

[in]	params	Tuning parameters.
[in,out]	report	Where to report errors.

Returns

True on success, false on error.

startTransmission()

bool ts::HiDesDevice::startTransmission

(

Report &

report = (ts::CerrReport::Instance())

)

Start transmission (after having set tuning parameters).

Parameters

[in,out]

report

Where to report errors.

Returns

True on success, false on error.

stopTransmission()

bool ts::HiDesDevice::stopTransmission

(

Report &

report = (ts::CerrReport::Instance())

)

Stop transmission.

Parameters

[in,out]

report

Where to report errors.

Returns

True on success, false on error.

send()

bool ts::HiDesDevice::send	(	const TSPacket *	data,
		size_t	packet_count,
		Report &	report = (ts::CerrReport::Instance()),
		AbortInterface *	abort = nullptr
	)

Send TS packets.

Parameters

[in]	data	Address of first TS packet to send.
[in]	packet_count	Number of contiguous packets to send.
[in,out]	report	Where to report errors.
[in]	abort	If non-zero, invoked when I/O is interrupted (in case of user-interrupt, return, otherwise retry).

Returns

True on success, false on error.

---

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

• tsHiDesDevice.h