CanSignalEncoder Class Reference

#include <cansignalencoder.h>

Inheritance diagram for CanSignalEncoder:

Collaboration diagram for CanSignalEncoder:

Public Slots
void	stopSimulation () override
void	startSimulation () override
void	simBcastRcv (const QJsonObject &msg, const QVariant &param) override
void	rcvSignal (const QString &name, const QVariant &val)

Signals
void	mainWidgetDockToggled (QWidget *widget) override
void	simBcastSnd (const QJsonObject &msg, const QVariant &param=QVariant()) override
void	requestRedraw ()
void	sndFrame (const QCanBusFrame &frame)

Public Member Functions
	CanSignalEncoder ()
	~CanSignalEncoder ()
QWidget *	mainWidget () override
	Gets components's main widget.
void	setConfig (const QJsonObject &json) override
	Sets configuration for component.
void	setConfig (const QWidget &qobject) override
	Sets configuration for component.
QJsonObject	getConfig () const override
	Gets current component configuation.
std::shared_ptr< QWidget >	getQConfig () const override
	Gets current component configuation.
void	configChanged () override
	Reconfigure component if necessary.
bool	mainWidgetDocked () const override
	Main widget docking status.
ComponentInterface::ComponentProperties	getSupportedProperties () const override
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
virtual void	mainWidgetDockToggled (QWidget *widget)=0
	Signal to be implemented by Component. Indicates when dock/undock action was invoked.
virtual void	stopSimulation ()=0
	Slot to be implemented by Component to execute simulation stop action.
virtual void	startSimulation ()=0
	Slot to be implemented by Component to execute simulation start action.
virtual void	simBcastSnd (const QJsonObject &msg, const QVariant &param=QVariant())=0
virtual void	simBcastRcv (const QJsonObject &msg, const QVariant &param)=0

Additional Inherited Members
Public Types inherited from ComponentInterface
using	PropertyEditable = bool
using	CustomEditFieldCbk = std::function< QWidget *(void)>
using	ComponentProperty = std::tuple< QString, QVariant::Type, PropertyEditable, CustomEditFieldCbk >
using	ComponentProperties = std::vector< ComponentProperty >
using	PropertyContainer = std::map< QString, QVariant >
Static Public Member Functions inherited from ComponentInterface
static constexpr const QString &	propertyName (const ComponentProperty &p)
static constexpr const QVariant::Type &	propertyType (const ComponentProperty &p)
static constexpr const PropertyEditable &	propertyEditability (const ComponentProperty &p)
static constexpr const CustomEditFieldCbk &	propertyField (const ComponentProperty &p)

Constructor & Destructor Documentation

CanSignalEncoder()

CanSignalEncoder::CanSignalEncoder

(

)

~CanSignalEncoder()

CanSignalEncoder::~CanSignalEncoder

(

)

Member Function Documentation

configChanged()

void CanSignalEncoder::configChanged ( )

overridevirtual

Reconfigure component if necessary.

Implements ComponentInterface.

getConfig()

QJsonObject CanSignalEncoder::getConfig ( ) const

overridevirtual

Gets current component configuation.

Returns

current config

Implements ComponentInterface.

getQConfig()

std::shared_ptr< QWidget > CanSignalEncoder::getQConfig ( ) const

overridevirtual

Gets current component configuation.

Returns

current config

Implements ComponentInterface.

getSupportedProperties()

ComponentInterface::ComponentProperties CanSignalEncoder::getSupportedProperties ( ) const

overridevirtual

Gets list of properties supported by this component

Returns

list of supported properties

Implements ComponentInterface.

mainWidget()

QWidget * CanSignalEncoder::mainWidget ( )

overridevirtual

Gets components's main widget.

Returns

Main widget or nullptr if component doesn't have it

Implements ComponentInterface.

mainWidgetDocked()

bool CanSignalEncoder::mainWidgetDocked ( ) const

overridevirtual

Main widget docking status.

Returns

returns true if widget is docked (part of MDI) or undocked (separate window)

Implements ComponentInterface.

mainWidgetDockToggled

void CanSignalEncoder::mainWidgetDockToggled ( QWidget *  widget )

overridesignal

rcvSignal

void CanSignalEncoder::rcvSignal ( const QString &  name, const QVariant &  val  )

slot

requestRedraw

void CanSignalEncoder::requestRedraw ( )

signal

setConfig() [1/2]

void CanSignalEncoder::setConfig ( const QJsonObject &  json )

overridevirtual

Sets configuration for component.

Parameters

json	configuration to be aplied

Implements ComponentInterface.

setConfig() [2/2]

void CanSignalEncoder::setConfig ( const QWidget &  qobject )

overridevirtual

Sets configuration for component.

Parameters

QWidget

configuration to be aplied

Implements ComponentInterface.

simBcastRcv

void CanSignalEncoder::simBcastRcv ( const QJsonObject &  msg, const QVariant &  param  )

overrideslot

simBcastSnd

void CanSignalEncoder::simBcastSnd ( const QJsonObject &  msg, const QVariant &  param = QVariant()  )

overridesignal

sndFrame

void CanSignalEncoder::sndFrame ( const QCanBusFrame &  frame )

signal

startSimulation

void CanSignalEncoder::startSimulation ( )

overrideslot

stopSimulation

void CanSignalEncoder::stopSimulation ( )

overrideslot

---

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

• src/components/cansignalencoder/cansignalencoder.h
• src/components/cansignalencoder/cansignalencoder.cpp