C++ API (icsneocpp)

Reference

namespace icsneo

Typedefs

typedef std::function<void(APIEvent::Type, APIEvent::Severity)> device_eventhandler_t

Functions

std::vector<std::shared_ptr<Device>> FindAllDevices()

std::vector<DeviceType> GetSupportedDevices()

size_t EventCount(EventFilter filter = EventFilter())

std::vector<APIEvent> GetEvents(EventFilter filter, size_t max = 0)

std::vector<APIEvent> GetEvents(size_t max = 0, EventFilter filter = EventFilter())

void GetEvents(std::vector<APIEvent> &events, EventFilter filter, size_t max = 0)

void GetEvents(std::vector<APIEvent> &events, size_t max = 0, EventFilter filter = EventFilter())

APIEvent GetLastError()

void DiscardEvents(EventFilter filter = EventFilter())

void SetEventLimit(size_t newLimit)

size_t GetEventLimit()

class Main51Message : public icsneo::Message

#include <main51message.h>

Subclassed by icsneo::SerialNumberMessage

class Message

#include <message.h>

Subclassed by icsneo::CANMessage, icsneo::EthernetMessage, icsneo::Main51Message, icsneo::ReadSettingsMessage, icsneo::ResetStatusMessage

class MessageCallback

#include <messagecallback.h>

Subclassed by icsneo::CANMessageCallback, icsneo::Main51MessageCallback

class MessageFilter

#include <messagefilter.h>

Subclassed by icsneo::CANMessageFilter, icsneo::Main51MessageFilter

class Device

Public Functions

virtual ~Device()

uint16_t getTimestampResolution() const

DeviceType getType() const

uint16_t getProductId() const

std::string getSerial() const

uint32_t getSerialNumber() const

const neodevice_t &getNeoDevice() const

std::string describe() const

virtual bool open()

virtual bool close()

virtual bool isOnline() const

virtual bool isOpen() const

virtual bool goOnline()

virtual bool goOffline()

bool enableMessagePolling()

bool disableMessagePolling()

bool isMessagePollingEnabled()

std::pair<std::vector<std::shared_ptr<Message>>, bool> getMessages()

bool getMessages(std::vector<std::shared_ptr<Message>> &container, size_t limit = 0, std::chrono::milliseconds timeout = std::chrono::milliseconds(0))

size_t getCurrentMessageCount()

size_t getPollingMessageLimit()

void setPollingMessageLimit(size_t newSize)

int addMessageCallback(const MessageCallback &cb)

bool removeMessageCallback(int id)

bool transmit(std::shared_ptr<Message> message)

bool transmit(std::vector<std::shared_ptr<Message>> messages)

void setWriteBlocks(bool blocks)

const std::vector<Network> &getSupportedRXNetworks() const

const std::vector<Network> &getSupportedTXNetworks() const

virtual bool isSupportedRXNetwork(const Network &net) const

virtual bool isSupportedTXNetwork(const Network &net) const

virtual size_t getNetworkCountByType(Network::Type) const

virtual Network getNetworkByNumber(Network::Type, size_t) const

virtual std::vector<std::shared_ptr<FlexRay::Controller>> getFlexRayControllers() const

const device_eventhandler_t &getEventHandler() const

Public Members

std::shared_ptr<Communication> com

std::unique_ptr<IDeviceSettings> settings

Public Static Functions

static std::string SerialNumToString(uint32_t serial)

static uint32_t SerialStringToNum(const std::string &serial)

static bool SerialStringIsNumeric(const std::string &serial)

Friends

std::ostream &operator<<(std::ostream &os, const Device &device)