winIDEA SDK
isys::CFNetCANCtrl Class Reference

Description

FNet Controller Area Network controller.

Python example: fnet_can.py

#include <CFNetCtrl.h>

Inheritance diagram for isys::CFNetCANCtrl:
isys::CFNetIPCtrl isys::WrapperBase

Public Member Functions

SPOptionFNetCANCfg cfg ()
 Returns CAN Option controller used for setting configuration. More...
 
SPOptionFNetCANOp op ()
 Returns CAN Option controller used for setting operation. More...
 
void ctrl_inject (const ECAN eLength, const uint32_t nID, const bool bFD, const bool bBRS, const bool bESI, const bool bRequest, const std::string &rstrData)
 Injects the CAN message on CAN bus with specified parameters. More...
 
void op_qualifier_enable (uint8_t nFTrigEnable)
 Enables the trigger. More...
 
void op_qualifier_disable (uint8_t nFTrigDisable)
 Disables the trigger. More...
 
void op_qualifier_enable_on_start (bool bEnableFromStart)
 Enables the trigger from start. More...
 
void op_set_qualifier (bool bEnableFromStart, uint8_t nFTrigEnable, uint8_t nFTrigDisable)
 

Member Function Documentation

◆ cfg()

SPOptionFNetCANCfg isys::CFNetCANCtrl::cfg ( )

Returns CAN Option controller used for setting configuration.

Returns
COptionFNetCANCfg

◆ ctrl_inject()

void isys::CFNetCANCtrl::ctrl_inject ( const ECAN  eLength,
const uint32_t  nID,
const bool  bFD,
const bool  bBRS,
const bool  bESI,
const bool  bRequest,
const std::string &  rstrData 
)

Injects the CAN message on CAN bus with specified parameters.

Parameters
eLengthlength of the message
nIDID
bFDset to send CAN FD packet (FD mode only)
bBRSset to send CAN FD packet with Bit Rate Switching (FD mode only)
bESIset to send in recessive mode (FD mode only)
bRequestmessage type: true for Request, false for Data
rstrDataCAN data

◆ op()

SPOptionFNetCANOp isys::CFNetCANCtrl::op ( )

Returns CAN Option controller used for setting operation.

Returns
COptionFNetCANOp

◆ op_qualifier_disable()

void isys::CFNetIPCtrl::op_qualifier_disable ( uint8_t  nFTrigDisable)
inherited

Disables the trigger.

Parameters
nFTrigDisableset 0 for none, 1-10 inclusive for the specific trigger

◆ op_qualifier_enable()

void isys::CFNetIPCtrl::op_qualifier_enable ( uint8_t  nFTrigEnable)
inherited

Enables the trigger.

Parameters
nFTrigEnableset 0 for none, 1-10 inclusive for the specific trigger

◆ op_qualifier_enable_on_start()

void isys::CFNetIPCtrl::op_qualifier_enable_on_start ( bool  bEnableFromStart)
inherited

Enables the trigger from start.

Parameters
bEnableFromStartenable recording when it occurs

◆ op_set_qualifier()

void isys::CFNetIPCtrl::op_set_qualifier ( bool  bEnableFromStart,
uint8_t  nFTrigEnable,
uint8_t  nFTrigDisable 
)
inherited
Parameters
bEnableFromStartrecording is enabled at session start
nFTrigEnableset 0 for none, 1-10 inclusive for the specific trigger
nFTrigDisableset 0 for none, 1-10 inclusive for the specific trigger