CanDeviceModel Class Reference

The class provides node graphical representation of CanDevice. More...

#include <candevicemodel.h>

Inheritance diagram for CanDeviceModel:

Collaboration diagram for CanDeviceModel:

Public Slots
void	frameReceived (const QCanBusFrame &frame)
	Callback, called when CanDevice emits signal frameReceived.
void	frameSent (bool status, const QCanBusFrame &frame)
	Callback, called when CanDevice emits signal frameReceived.

Signals
void	sendFrame (const QCanBusFrame &frame)
	Used to send a frame.
void	requestRedraw ()
Signals inherited from ComponentModelInterface
void	startSimulation ()
void	stopSimulation ()
void	handleDock (QWidget *widget)
void	simBcastSnd (const QJsonObject &msg, const QVariant &param)

Public Member Functions
	CanDeviceModel ()
unsigned int	nPorts (PortType portType) const override
	Used to get number of ports of each type used by model.
NodeDataType	dataType (PortType portType, PortIndex portIndex) const override
	Used to get data type of each port.
std::shared_ptr< NodeData >	outData (PortIndex port) override
	Sets output data for propagation.
void	setInData (std::shared_ptr< NodeData > nodeData, PortIndex port) override
	Handles data on input port, sends frame if correct.
QtNodes::NodePainterDelegate *	painterDelegate () const override
	Used to provide custom painter to nodeeditor.
virtual bool	hasSeparateThread () const override
Public Member Functions inherited from ComponentModel< CanDevice, CanDeviceModel >
	ComponentModel ()=default
	ComponentModel (const QString &name)
virtual	~ComponentModel ()
virtual void	initModel (QtNodes::Node &node, int nodeCnt, bool darkMode) override
virtual QString	caption () const override
	Used to get node caption.
virtual void	setCaption (const QString &caption) override
	Sets model caption and updates widget title.
virtual QString	name () const override
	Used to identify model by data model name.
virtual std::unique_ptr< QtNodes::NodeDataModel >	clone () const override
	Creates new node of the same type.
virtual QJsonObject	save () const override
	Possibility to save node properties.
virtual void	restore (QJsonObject const &json) override
	Used to restore node configurations.
virtual QWidget *	embeddedWidget () override
	Used to get widget embedded in Node.
virtual bool	resizable () const override
	Used to get information if node is resizable.
virtual ComponentInterface &	getComponent () override
	Component getter.
virtual bool	restored () override
virtual void	setColorMode (bool darkMode) override
void	simBcastRcv (const QJsonObject &msg, const QVariant &param) override
void	simBcastSndSlot (const QJsonObject &msg, const QVariant &param) override
Public Member Functions inherited from ComponentModelInterface
virtual	~ComponentModelInterface ()=default

Additional Inherited Members
Protected Attributes inherited from ComponentModel< CanDevice, CanDeviceModel >
CanDevice	_component
QLabel *	_label
QString	_caption
QString	_name
bool	_resizable
bool	_restored
bool	_darkMode
QtNodes::NodeStyle	_nodeStyle
std::unique_ptr< QThread >	_thread
QUuid	_id

Detailed Description

The class provides node graphical representation of CanDevice.

Constructor & Destructor Documentation

CanDeviceModel()

CanDeviceModel::CanDeviceModel

(

)

Member Function Documentation

dataType()

NodeDataType CanDeviceModel::dataType ( PortType  portType, PortIndex  portIndex  ) const

override

Used to get data type of each port.

Parameters

type	of port @patam port id

Returns

CanDeviceDataOut type if portType is out, CanDeviceDataIn type if portType is in

frameReceived

void CanDeviceModel::frameReceived ( const QCanBusFrame &  frame )

slot

Callback, called when CanDevice emits signal frameReceived.

Parameters

received

frame

frameSent

void CanDeviceModel::frameSent ( bool  status, const QCanBusFrame &  frame  )

slot

Callback, called when CanDevice emits signal frameReceived.

Parameters

status	indicating if sending frame was successful
sent	frame

hasSeparateThread()

virtual bool CanDeviceModel::hasSeparateThread ( ) const

inlineoverridevirtual

Reimplemented from ComponentModel< CanDevice, CanDeviceModel >.

nPorts()

unsigned int CanDeviceModel::nPorts ( PortType  portType ) const

override

Used to get number of ports of each type used by model.

Parameters

type

of port

Returns

1 if port in or out, 0 if any other type

outData()

std::shared_ptr< NodeData > CanDeviceModel::outData ( PortIndex  port )

override

Sets output data for propagation.

Parameters

port

id

Returns

CanDeviceDataOut or CanDeviceDataIn filled with data

painterDelegate()

QtNodes::NodePainterDelegate * CanDeviceModel::painterDelegate ( ) const

override

Used to provide custom painter to nodeeditor.

Returns

NodePainterDelegate used to perform custom node painting

requestRedraw

void CanDeviceModel::requestRedraw ( )

signal

sendFrame

void CanDeviceModel::sendFrame ( const QCanBusFrame &  frame )

signal

Used to send a frame.

Parameters

frame

Frame to be sent

setInData()

void CanDeviceModel::setInData ( std::shared_ptr< NodeData >  nodeData, PortIndex  port  )

override

Handles data on input port, sends frame if correct.

Parameters

data	on port
port	id

---

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

• src/components/candevice/candevicemodel.h
• src/components/candevice/candevicemodel.cpp