CANdevStudio
Development tool for CAN bus simulation
Loading...
Searching...
No Matches
Public Slots | Signals | Public Member Functions | List of all members
CanDevice Class Reference

The class provides abstraction layer for CAN BUS hardware. More...

#include <candevice.h>

Inheritance diagram for CanDevice:
Inheritance graph
[legend]
Collaboration diagram for CanDevice:
Collaboration graph
[legend]

Public Slots

void sendFrame (const QCanBusFrame &frame)
 
void startSimulation () override
 
void stopSimulation () override
 
void simBcastRcv (const QJsonObject &msg, const QVariant &param) override
 

Signals

void frameReceived (const QCanBusFrame &frame)
 
void frameSent (bool status, const QCanBusFrame &frame)
 
void mainWidgetDockToggled (QWidget *widget) override
 
void simBcastSnd (const QJsonObject &msg, const QVariant &param=QVariant()) override
 

Public Member Functions

 CanDevice ()
 
 CanDevice (CanDeviceCtx &&ctx)
 
 ~CanDevice ()
 
bool init ()
 Configures CAN BUS backend and interface.
 
QWidget * mainWidget () override
 
void setConfig (const QJsonObject &json) override
 
void setConfig (const QWidget &qobject) override
 
QJsonObject getConfig () const override
 
std::shared_ptr< QWidget > getQConfig () const override
 
virtual void configChanged () override
 
bool mainWidgetDocked () const override
 
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)
 

Detailed Description

The class provides abstraction layer for CAN BUS hardware.

Constructor & Destructor Documentation

◆ CanDevice() [1/2]

CanDevice::CanDevice ( )
explicit

◆ CanDevice() [2/2]

CanDevice::CanDevice ( CanDeviceCtx &&  ctx)
explicit

◆ ~CanDevice()

CanDevice::~CanDevice ( )

Member Function Documentation

◆ configChanged()

void CanDevice::configChanged ( )
overridevirtual
See also
ComponentInterface

Implements ComponentInterface.

◆ frameReceived

void CanDevice::frameReceived ( const QCanBusFrame &  frame)
signal

◆ frameSent

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

◆ getConfig()

QJsonObject CanDevice::getConfig ( ) const
overridevirtual
See also
ComponentInterface

Implements ComponentInterface.

◆ getQConfig()

std::shared_ptr< QWidget > CanDevice::getQConfig ( ) const
overridevirtual
See also
ComponentInterface

Implements ComponentInterface.

◆ getSupportedProperties()

ComponentInterface::ComponentProperties CanDevice::getSupportedProperties ( ) const
overridevirtual
See also
ComponentInterface

Implements ComponentInterface.

◆ init()

bool CanDevice::init ( )

Configures CAN BUS backend and interface.

This function configures QtCanBus class with backend and interface values stored in properties.

Returns
true on success, false on failure

◆ mainWidget()

QWidget * CanDevice::mainWidget ( )
overridevirtual
See also
ComponentInterface

Implements ComponentInterface.

◆ mainWidgetDocked()

bool CanDevice::mainWidgetDocked ( ) const
overridevirtual
See also
ComponentInterface

Implements ComponentInterface.

◆ mainWidgetDockToggled

void CanDevice::mainWidgetDockToggled ( QWidget *  widget)
overridesignal
See also
ComponentInterface

◆ sendFrame

void CanDevice::sendFrame ( const QCanBusFrame &  frame)
slot

◆ setConfig() [1/2]

void CanDevice::setConfig ( const QJsonObject &  json)
overridevirtual
See also
ComponentInterface

Implements ComponentInterface.

◆ setConfig() [2/2]

void CanDevice::setConfig ( const QWidget &  qobject)
overridevirtual
See also
ComponentInterface

Implements ComponentInterface.

◆ simBcastRcv

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

◆ simBcastSnd

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

◆ startSimulation

void CanDevice::startSimulation ( )
overrideslot
See also
ComponentInterface

◆ stopSimulation

void CanDevice::stopSimulation ( )
overrideslot
See also
ComponentInterface
The documentation for this class was generated from the following files: