ComponentRegister Class Reference

The component register reflects and manages the current state of all components and Hyperion as a whole It emits also real component state changes (triggert from the specific component), which can be used for listening APIs (Network Clients/Plugins) More...

#include <ComponentRegister.h>

Inheritance diagram for ComponentRegister:

Public Slots
void	componentStateChanged (const hyperion::Components comp, const bool activated)
	is called whenever a component change a state, DO NOT CALL FROM API (use hyperion->setComponentState() instead) More...

Signals
void	updatedComponentState (const hyperion::Components comp, const bool state)
	Emits whenever a component changed (really) the state. More...

Public Member Functions
	ComponentRegister (Hyperion *hyperion)
bool	setHyperionEnable (const bool &state)
	Enable or disable Hyperion (all components) More...
int	isComponentEnabled (const hyperion::Components &comp) const
	Check if a component is currently enabled. More...
std::map< hyperion::Components, bool >	getRegister ()
	contains all components and their state

Detailed Description

The component register reflects and manages the current state of all components and Hyperion as a whole It emits also real component state changes (triggert from the specific component), which can be used for listening APIs (Network Clients/Plugins)

Member Function Documentation

componentStateChanged

void ComponentRegister::componentStateChanged ( const hyperion::Components  comp, const bool  activated  )

slot

is called whenever a component change a state, DO NOT CALL FROM API (use hyperion->setComponentState() instead)

Parameters

comp	The component
state	The new state of the component

isComponentEnabled()

int ComponentRegister::isComponentEnabled

(

const hyperion::Components &

comp

)

const

Check if a component is currently enabled.

Parameters

comp	The component from enum

Returns

True if component is running else false. Not found is -1

setHyperionEnable()

bool ComponentRegister::setHyperionEnable

(

const bool &

state

)

Enable or disable Hyperion (all components)

Parameters

state

The new state of Hyperion

Returns

Returns true on success, false when Hyperion is already at the requested state

updatedComponentState

void ComponentRegister::updatedComponentState ( const hyperion::Components  comp, const bool  state  )

signal

Emits whenever a component changed (really) the state.

Parameters

comp	The component
state	The new state of the component

---

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

• include/hyperion/ComponentRegister.h
• libsrc/hyperion/ComponentRegister.cpp