DVB-S device tree class. More...

#include <libmythtv/diseqc.h>

Collaboration diagram for DiSEqCDevTree:

Public Member Functions
	DiSEqCDevTree ()

	~DiSEqCDevTree ()

bool	Load (const QString &device)
	Loads the device tree from the database. More...

bool	Load (uint cardid)
	Loads the device tree from the database. More...

bool	Store (uint cardid, const QString &device="")
	Stores the device tree to the database. More...

bool	Execute (const DiSEqCDevSettings &settings, const DTVMultiplex &tuning)
	Applies settings to the entire tree. More...

void	Reset (void)
	Reset state of nodes in tree, forcing updates on the next Execute command. More...

DiSEqCDevRotor *	FindRotor (const DiSEqCDevSettings &settings, uint index=0)
	Returns the nth rotor device object in the tree. More...

DiSEqCDevLNB *	FindLNB (const DiSEqCDevSettings &settings)
	Returns the LNB device object selected by the configuration chain. More...

DiSEqCDevSCR *	FindSCR (const DiSEqCDevSettings &settings)
	Returns the SCR device object selected by the configuration chain. More...

DiSEqCDevDevice *	FindDevice (uint dev_id)
	Returns a device by ID. More...

DiSEqCDevDevice *	Root (void)
	Retrieves the root node in the tree. More...

void	SetRoot (DiSEqCDevDevice *root)
	Changes the root node of the tree. More...

bool	SendCommand (uint adr, uint cmd, uint repeats, cmd_vec_t &data) const

bool	SendCommand (uint adr, uint cmd, uint repeats=0) const

bool	ResetDiseqc (bool hard_reset, bool is_SCR)
	Resets the DiSEqC bus. More...

void	Open (int fd_frontend, bool is_SCR)
	Retrieve device tree. More...

void	Close (void)

int	GetFD (void) const

bool	SetTone (bool on) const

bool	SetVoltage (uint voltage)

uint	GetVoltage (void) const

bool	IsInNeedOfConf (void) const

void	AddDeferredDelete (uint dev_id)

uint	CreateFakeDiSEqCID (void)

Static Public Member Functions
static bool	IsFakeDiSEqCID (uint id)

static bool	Exists (int cardid)
	Check if a Diseqc device tree exists. More...

Protected Member Functions
bool	ApplyVoltage (const DiSEqCDevSettings &settings, const DTVMultiplex &tuning)

Protected Attributes
int	m_fdFrontend {-1}

DiSEqCDevDevice *	m_root {nullptr}

uint	m_lastVoltage {UINT_MAX}

uint	m_previousFakeDiseqcid {kFirstFakeDiSEqCID}

std::vector< uint >	m_delete

Static Protected Attributes
static const uint	kFirstFakeDiSEqCID = 0xf0000000

Detailed Description

DVB-S device tree class.

Represents a tree of DVB-S devices.

Definition at line 74 of file diseqc.h.

Constructor & Destructor Documentation

◆ DiSEqCDevTree()

DiSEqCDevTree::DiSEqCDevTree ( )

inline

Definition at line 77 of file diseqc.h.

◆ ~DiSEqCDevTree()

DiSEqCDevTree::~DiSEqCDevTree ( )

Definition at line 301 of file diseqc.cpp.

Member Function Documentation

◆ AddDeferredDelete()

void DiSEqCDevTree::AddDeferredDelete ( uint dev_id )

inline

Definition at line 120 of file diseqc.h.

Referenced by DiSEqCDevDevice::~DiSEqCDevDevice().

◆ ApplyVoltage()

bool DiSEqCDevTree::ApplyVoltage	(	const DiSEqCDevSettings &	settings,
		const DTVMultiplex &	tuning
	)

protected

Definition at line 842 of file diseqc.cpp.

Referenced by Execute().

◆ Close()

void DiSEqCDevTree::Close ( void )

inline

Definition at line 108 of file diseqc.h.

Referenced by DVBChannel::Close().

◆ CreateFakeDiSEqCID()

uint DiSEqCDevTree::CreateFakeDiSEqCID ( void )

inline

Definition at line 121 of file diseqc.h.

Referenced by DiSEqCDevDevice::CreateByType().

◆ Execute()

bool DiSEqCDevTree::Execute	(	const DiSEqCDevSettings &	settings,
		const DTVMultiplex &	tuning
	)

Applies settings to the entire tree.

Parameters

settings	Configuration chain to apply.
tuning	Tuning parameters.

Returns: True if execution completed successfully.

Definition at line 509 of file diseqc.cpp.

Referenced by DVBChannel::Tune().

◆ Exists()

bool DiSEqCDevTree::Exists ( int cardid )

static

Check if a Diseqc device tree exists.

Parameters

cardid Capture card id.

Returns: True if exists.

Definition at line 393 of file diseqc.cpp.

Referenced by DVBConfigurationGroup::Load().

◆ FindDevice()

DiSEqCDevDevice * DiSEqCDevTree::FindDevice ( uint dev_id )

Returns a device by ID.

Parameters

dev_id Device ID to find.

Returns: Pointer to device, or nullptr if not found in this tree.

Definition at line 620 of file diseqc.cpp.

◆ FindLNB()

DiSEqCDevLNB * DiSEqCDevTree::FindLNB ( const DiSEqCDevSettings & settings )

Returns the LNB device object selected by the configuration chain.

Parameters

settings Configuration chain in effect.

Returns: Pointer to LNB object if found, nullptr otherwise.

Definition at line 573 of file diseqc.cpp.

Referenced by DiSEqCDevSCR::Execute(), DiSEqCDevSwitch::ExecuteDiseqc(), DiSEqCDevSwitch::ExecuteLegacy(), DiSEqCDevSwitch::ShouldSwitch(), and DVBChannel::Tune().

◆ FindRotor()

DiSEqCDevRotor * DiSEqCDevTree::FindRotor	(	const DiSEqCDevSettings &	settings,
		uint	index = `0`
	)

Returns the nth rotor device object in the tree.

Parameters

settings	Configuration chain in effect.
index	0 for first rotor, 1 for second, etc.

Returns: Pointer to rotor object if found, nullptr otherwise.

Definition at line 550 of file diseqc.cpp.

Referenced by DVBChannel::GetRotor().

◆ FindSCR()

DiSEqCDevSCR * DiSEqCDevTree::FindSCR ( const DiSEqCDevSettings & settings )

Returns the SCR device object selected by the configuration chain.

Parameters

settings Configuration chain in effect.

Returns: Pointer to SCR object if found, nullptr otherwise.

Definition at line 596 of file diseqc.cpp.

Referenced by DVBChannel::Open(), and DVBChannel::Tune().

◆ GetFD()

int DiSEqCDevTree::GetFD ( void ) const

inline

Definition at line 109 of file diseqc.h.

Referenced by DiSEqCDevSwitch::ExecuteLegacy(), DiSEqCDevSwitch::ExecuteMiniDiSEqC(), DiSEqCDevSwitch::ExecuteTone(), DiSEqCDevSwitch::ExecuteVoltage(), and SendCommand().

◆ GetVoltage()

uint DiSEqCDevTree::GetVoltage ( void ) const

inline

Definition at line 116 of file diseqc.h.

Referenced by DiSEqCDevRotor::GetProgress().

◆ IsFakeDiSEqCID()

static bool DiSEqCDevTree::IsFakeDiSEqCID ( uint id )

inlinestatic

Definition at line 123 of file diseqc.h.

Referenced by DiSEqCDevDevice::IsRealDeviceID().

◆ IsInNeedOfConf()

bool DiSEqCDevTree::IsInNeedOfConf ( void ) const

Definition at line 834 of file diseqc.cpp.

Referenced by CardUtil::IsInNeedOfExternalInputConf().

◆ Load() [1/2]

bool DiSEqCDevTree::Load ( const QString & device )

Loads the device tree from the database.

Parameters

device recording input uses.

Returns: True if successful.

Definition at line 311 of file diseqc.cpp.

Referenced by CardUtil::DeleteInput(), DTVDeviceConfigGroup::DTVDeviceConfigGroup(), DiSEqCDevTrees::FindTree(), Load(), and DVBConfigurationGroup::reloadDiseqcTree().

◆ Load() [2/2]

bool DiSEqCDevTree::Load ( uint cardid )

Loads the device tree from the database.

Parameters

cardid Capture card id.

Returns: True if successful.

Definition at line 343 of file diseqc.cpp.

◆ Open()

void DiSEqCDevTree::Open	(	int	fd_frontend,
		bool	is_SCR
	)

Retrieve device tree.

Parameters

fd_frontend	DVB frontend device file descriptor.
is_SCR	Is this an SCR bus?

Definition at line 790 of file diseqc.cpp.

Referenced by DVBChannel::Open().

◆ Reset()

void DiSEqCDevTree::Reset ( void )

Reset state of nodes in tree, forcing updates on the next Execute command.

Returns: True if reset completed successfully.

Definition at line 536 of file diseqc.cpp.

Referenced by DiSEqCDevTree(), and ResetDiseqc().

◆ ResetDiseqc()

bool DiSEqCDevTree::ResetDiseqc	(	bool	hard_reset,
		bool	is_SCR
	)

Resets the DiSEqC bus.

Parameters

hard_reset	If true, the bus will be power cycled.
is_SCR	Is this an SCR bus?

Returns: True if successful.

Definition at line 741 of file diseqc.cpp.

Referenced by Open().

◆ Root()

DiSEqCDevDevice * DiSEqCDevTree::Root ( void )

inline

Retrieves the root node in the tree.

Definition at line 93 of file diseqc.h.

Referenced by CardUtil::DeleteInput(), DTVDeviceConfigGroup::DTVDeviceConfigGroup(), and DeviceTree::PopulateTree().

◆ SendCommand() [1/2]

bool DiSEqCDevTree::SendCommand	(	uint	adr,
		uint	cmd,
		uint	repeats,
		cmd_vec_t &	data
	)		const

Definition at line 672 of file diseqc.cpp.

Referenced by DiSEqCDevSwitch::ExecuteDiseqc(), DiSEqCDevRotor::ExecuteRotor(), DiSEqCDevRotor::ExecuteUSALS(), ResetDiseqc(), SendCommand(), and DiSEqCDevSCR::SendCommand().

◆ SendCommand() [2/2]

bool DiSEqCDevTree::SendCommand	(	uint	adr,
		uint	cmd,
		uint	repeats = `0`
	)		const

inline

Definition at line 98 of file diseqc.h.

◆ SetRoot()

void DiSEqCDevTree::SetRoot ( DiSEqCDevDevice * root )

Changes the root node of the tree.

Parameters

root	New root node (may be nullptr).

Definition at line 632 of file diseqc.cpp.

Referenced by DeviceTree::DeleteDevice(), CardUtil::DeleteInput(), and DeviceTree::ValueChanged().

◆ SetTone()

bool DiSEqCDevTree::SetTone ( bool on ) const

Definition at line 482 of file diseqc.cpp.

Referenced by Execute(), and DiSEqCDevLNB::Execute().

◆ SetVoltage()

bool DiSEqCDevTree::SetVoltage ( uint voltage )

Definition at line 798 of file diseqc.cpp.

Referenced by ApplyVoltage(), ResetDiseqc(), and DiSEqCDevSCR::SendCommand().

◆ Store()

bool DiSEqCDevTree::Store	(	uint	cardid,
		const QString &	device = `""`
	)

Stores the device tree to the database.

Parameters

cardid	Capture card id.
device	Device id.

Returns: True if successful.

Definition at line 422 of file diseqc.cpp.

Referenced by CardUtil::DeleteInput(), and DVBConfigurationGroup::Save().

Member Data Documentation

◆ kFirstFakeDiSEqCID

const uint DiSEqCDevTree::kFirstFakeDiSEqCID = 0xf0000000

staticprotected

Definition at line 136 of file diseqc.h.

Referenced by IsFakeDiSEqCID().

◆ m_delete

std::vector<uint> DiSEqCDevTree::m_delete

protected

Definition at line 134 of file diseqc.h.

Referenced by AddDeferredDelete(), Load(), and Store().

◆ m_fdFrontend

int DiSEqCDevTree::m_fdFrontend {-1}

protected

Definition at line 130 of file diseqc.h.

Referenced by Close(), GetFD(), Open(), SetTone(), and SetVoltage().

◆ m_lastVoltage

uint DiSEqCDevTree::m_lastVoltage {UINT_MAX}

protected

Definition at line 132 of file diseqc.h.

Referenced by GetVoltage(), Reset(), and SetVoltage().

◆ m_previousFakeDiseqcid

uint DiSEqCDevTree::m_previousFakeDiseqcid {kFirstFakeDiSEqCID}

protected

Definition at line 133 of file diseqc.h.

Referenced by CreateFakeDiSEqCID().

◆ m_root

DiSEqCDevDevice* DiSEqCDevTree::m_root {nullptr}

protected

Definition at line 131 of file diseqc.h.

Referenced by ApplyVoltage(), Execute(), FindDevice(), FindLNB(), FindRotor(), FindSCR(), IsInNeedOfConf(), Load(), Reset(), Root(), SetRoot(), Store(), and ~DiSEqCDevTree().

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

mythtv/libs/libmythtv/diseqc.h
mythtv/libs/libmythtv/diseqc.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DiSEqCDevTree()

◆ ~DiSEqCDevTree()

Member Function Documentation

◆ AddDeferredDelete()

◆ ApplyVoltage()

◆ Close()

◆ CreateFakeDiSEqCID()

◆ Execute()

◆ Exists()

◆ FindDevice()

◆ FindLNB()

◆ FindRotor()

◆ FindSCR()

◆ GetFD()

◆ GetVoltage()

◆ IsFakeDiSEqCID()

◆ IsInNeedOfConf()

◆ Load() [1/2]

◆ Load() [2/2]

◆ Open()

◆ Reset()

◆ ResetDiseqc()

◆ Root()

◆ SendCommand() [1/2]

◆ SendCommand() [2/2]

◆ SetRoot()

◆ SetTone()

◆ SetVoltage()

◆ Store()

Member Data Documentation

◆ kFirstFakeDiSEqCID

◆ m_delete

◆ m_fdFrontend

◆ m_lastVoltage

◆ m_previousFakeDiseqcid

◆ m_root