HardFOC Core
API reference
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
hf::host::MockCan Class Reference

#include <MockCan.h>

Inheritance diagram for hf::host::MockCan:

Public Member Functions

 MockCan () noexcept=default
 
 ~MockCan () noexcept override=default
 
hf_can_err_t Initialize () noexcept override
 
hf_can_err_t Deinitialize () noexcept override
 
hf_can_err_t SendMessage (const hf_can_message_t &message, hf_u32_t timeout_ms=1000) noexcept override
 
hf_can_err_t ReceiveMessage (hf_can_message_t &message, hf_u32_t timeout_ms=0) noexcept override
 
hf_can_err_t SetReceiveCallback (hf_can_receive_callback_t callback) noexcept override
 
void ClearReceiveCallback () noexcept override
 
hf_can_err_t SetAcceptanceFilter (hf_u32_t id, hf_u32_t mask, bool extended=false) noexcept override
 
hf_can_err_t ClearAcceptanceFilter () noexcept override
 
hf_can_err_t GetStatus (hf_can_status_t &status) noexcept override
 
hf_can_err_t Reset () noexcept override
 
void SetInitializeResult (hf_can_err_t result) noexcept
 
bool InjectRx (const hf_can_message_t &message)
 
void FailNextSend (hf_can_err_t error, size_t count=1) noexcept
 
void SetBusOff (bool bus_off) noexcept
 
const std::vector< hf_can_message_t > & SentFrames () const noexcept
 
void ClearSent () noexcept
 
size_t PendingRx () const noexcept
 
int ResetCalls () const noexcept
 

Static Public Member Functions

static hf_can_message_t Frame (hf_u32_t id, std::initializer_list< uint8_t > data, bool extended=false) noexcept
 

Private Member Functions

bool Accepts (const hf_can_message_t &message) const noexcept
 

Private Attributes

hf_can_err_t init_result_ {hf_can_err_t::CAN_SUCCESS}
 
hf_can_receive_callback_t callback_ {nullptr}
 
std::vector< hf_can_message_t > sent_
 
std::deque< hf_can_message_t > rx_
 
bool filter_set_ {false}
 
hf_u32_t filter_id_ {0}
 
hf_u32_t filter_mask_ {0}
 
bool filter_extended_ {false}
 
hf_can_err_t fail_error_ {hf_can_err_t::CAN_ERR_TX_FAILED}
 
size_t fail_count_ {0}
 
bool bus_off_ {false}
 
int reset_calls_ {0}
 
hf_u32_t tx_failed_ {0}
 

Constructor & Destructor Documentation

◆ MockCan()

hf::host::MockCan::MockCan ( )
defaultnoexcept

◆ ~MockCan()

hf::host::MockCan::~MockCan ( )
overridedefaultnoexcept

Member Function Documentation

◆ Accepts()

bool hf::host::MockCan::Accepts ( const hf_can_message_t &  message) const
privatenoexcept

◆ ClearAcceptanceFilter()

hf_can_err_t hf::host::MockCan::ClearAcceptanceFilter ( )
overridenoexcept

◆ ClearReceiveCallback()

void hf::host::MockCan::ClearReceiveCallback ( )
inlineoverridenoexcept

◆ ClearSent()

void hf::host::MockCan::ClearSent ( )
inlinenoexcept

◆ Deinitialize()

hf_can_err_t hf::host::MockCan::Deinitialize ( )
inlineoverridenoexcept

◆ FailNextSend()

void hf::host::MockCan::FailNextSend ( hf_can_err_t  error,
size_t  count = 1 
)
noexcept

◆ Frame()

hf_can_message_t hf::host::MockCan::Frame ( hf_u32_t  id,
std::initializer_list< uint8_t >  data,
bool  extended = false 
)
staticnoexcept

Build a classic data frame.

◆ GetStatus()

hf_can_err_t hf::host::MockCan::GetStatus ( hf_can_status_t &  status)
overridenoexcept

◆ Initialize()

hf_can_err_t hf::host::MockCan::Initialize ( )
overridenoexcept

◆ InjectRx()

bool hf::host::MockCan::InjectRx ( const hf_can_message_t &  message)

Deliver a frame from the bus. Returns false if the acceptance filter dropped it.

◆ PendingRx()

size_t hf::host::MockCan::PendingRx ( ) const
inlinenoexcept

◆ ReceiveMessage()

hf_can_err_t hf::host::MockCan::ReceiveMessage ( hf_can_message_t &  message,
hf_u32_t  timeout_ms = 0 
)
overridenoexcept

◆ Reset()

hf_can_err_t hf::host::MockCan::Reset ( )
overridenoexcept

◆ ResetCalls()

int hf::host::MockCan::ResetCalls ( ) const
inlinenoexcept

◆ SendMessage()

hf_can_err_t hf::host::MockCan::SendMessage ( const hf_can_message_t &  message,
hf_u32_t  timeout_ms = 1000 
)
overridenoexcept

◆ SentFrames()

const std::vector< hf_can_message_t > & hf::host::MockCan::SentFrames ( ) const
inlinenoexcept

◆ SetAcceptanceFilter()

hf_can_err_t hf::host::MockCan::SetAcceptanceFilter ( hf_u32_t  id,
hf_u32_t  mask,
bool  extended = false 
)
overridenoexcept

◆ SetBusOff()

void hf::host::MockCan::SetBusOff ( bool  bus_off)
inlinenoexcept

◆ SetInitializeResult()

void hf::host::MockCan::SetInitializeResult ( hf_can_err_t  result)
inlinenoexcept

◆ SetReceiveCallback()

hf_can_err_t hf::host::MockCan::SetReceiveCallback ( hf_can_receive_callback_t  callback)
overridenoexcept

Member Data Documentation

◆ bus_off_

bool hf::host::MockCan::bus_off_ {false}
private

◆ callback_

hf_can_receive_callback_t hf::host::MockCan::callback_ {nullptr}
private

◆ fail_count_

size_t hf::host::MockCan::fail_count_ {0}
private

◆ fail_error_

hf_can_err_t hf::host::MockCan::fail_error_ {hf_can_err_t::CAN_ERR_TX_FAILED}
private

◆ filter_extended_

bool hf::host::MockCan::filter_extended_ {false}
private

◆ filter_id_

hf_u32_t hf::host::MockCan::filter_id_ {0}
private

◆ filter_mask_

hf_u32_t hf::host::MockCan::filter_mask_ {0}
private

◆ filter_set_

bool hf::host::MockCan::filter_set_ {false}
private

◆ init_result_

hf_can_err_t hf::host::MockCan::init_result_ {hf_can_err_t::CAN_SUCCESS}
private

◆ reset_calls_

int hf::host::MockCan::reset_calls_ {0}
private

◆ rx_

std::deque<hf_can_message_t> hf::host::MockCan::rx_
private

◆ sent_

std::vector<hf_can_message_t> hf::host::MockCan::sent_
private

◆ tx_failed_

hf_u32_t hf::host::MockCan::tx_failed_ {0}
private

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