iv::comms::can Namespace Reference

Classes
class	AbstractMessageProcessor
struct	CanDataMessage
class	CanMessageFactory
struct	canMessageIds
struct	canMessageLengths
class	ICanCommunicationProtocol
class	LomCommunicationController
class	LomCommunicationControllerFrame
class	LomMessageProcessor
class	LomMessageProcessorFrame
class	PcanGatewayCommunicationProtocol
class	WatchCallMessageProcessor
class	WatchCallMessageProcessorFrame

Enumerations
enum class	eMessageType {   Heartbeat , AnalogInput , SlimStatusUpdate , Text ,   Alarm , Command , AlarmTimestamp , DigitalInput_0_63 ,   DigitalInput_64_127 , DigitalInput_128_191 , LssSlave , LssMaster ,   SdoRequestFromClient , SdoResponseFromServer , AlarmGroupsStatus , NmtService ,   TimestampSync , HistorySync , HistoryAckSync , GmtSync ,   Undefined }
enum class	eBroadcastType { NewAlarm = 0x00 , SoundOff = 0x01 , SoundAck = 0x02 , SoundDeadMan = 0x03 }

Functions
bool	prvReadNextDataSegment (const std::shared_ptr< iv::streams::IInputStream > &input, uint64_t &lengthDataLeft, char **dataBuffer, const int64_t sizeSegments)
void	prvGetIdLocalUnitAndSubnetwork (iv::types::unitId idUnit, iv::types::unitId *idLocalUnit, iv::types::subnetwork *idSubnetwork)
bool	isInSdoResponseCanIdRange (const uint32_t canId)
bool	isInHeartbeatCanIdRange (const uint32_t canId)
bool	isHeartbeatOk (const iv::comms::eHeartbeatState heartbeatState)
uint8_t	prvIdUnitStation (iv::types::unitId idStation)
uint16_t	prvIndexChannelBroadCast (iv::model::eShipArea areaStation, uint16_t typeBroadcast)
bool	isWatchCall (uint16_t indexChannel, uint16_t *areaRepeater)
bool	isBroadCastCommand (uint16_t indexChannel, iv::comms::can::eBroadcastType *typeBroadCast, uint16_t *typeZoneRepeaters)
uint16_t	indexChannelBroadcastNewAlarm (iv::model::eShipArea stationArea)
uint16_t	indexChannelBroadcastSoundOff (iv::model::eShipArea stationArea)
void	getIdUnitLocalAndSubnetwork (iv::types::unitId idUnit, iv::types::unitId *idUnitLocal, iv::types::subnetwork *idSubnetwork)
void	getNumDaysAndMillisecondsSinceLOMBaseDate (iv::types::timestamp now, uint16_t &daysSince1984, uint32_t &milliseconds)
uint16_t	getIdUnitGlobal (uint16_t idUnitLocal, uint16_t idSubnetwork)
uint16_t	idUnitStation (uint16_t idStation)
bool	isEqualMessageCAN (const iv::comms::can::CanDataMessage *message1, const iv::comms::can::CanDataMessage *message2)
iv::comms::can::eMessageType	getMessageType (const uint64_t msgId)
unsigned char	idTypeRepeaterByArea (iv::model::eShipArea eAreaShip)

Variables
constexpr uint32_t	kPrvUnitIdMask = 0x07F
constexpr uint16_t	kPrvAllSubnetwork = 0xFFFF
constexpr uint8_t	kPrvFirstStation = 119
constexpr uint16_t	kPrvMaxModulesForSubnetwork = 1000
constexpr uint16_t	kPrvMaxNumberModulesInSubnetwork = 127
constexpr uint8_t	kPrvAllNode = 0
constexpr uint8_t	kPrvCommandStopNode = 2
constexpr uint8_t	kPrvCommandPreOperationalNode = 0x80
constexpr uint8_t	kPrvCommandResetNode = 0x81
constexpr uint8_t	kPrvCommandACK = 0x80
constexpr uint8_t	kPrvCommandCtrl = 0x81
constexpr uint8_t	kPrvTypeRealValue = 0x90
constexpr uint8_t	kPrvTypeTextPositionMask = 0x3F
constexpr uint8_t	kPrvTypeTextStateMask = 0xC0
constexpr uint8_t	kPrvTypeTextConcat = 0x00
constexpr uint8_t	kPrvTypeTextInit = 0x40
constexpr uint8_t	kPrvTypeTextFinish = 0x80
constexpr uint8_t	kPrvCommandOnDutyWatchCall = 0x01
constexpr uint8_t	kPrvCommandCallAllWatchCallEcr = 1
constexpr uint8_t	kPrvCommandCallAllOff = 0
constexpr uint8_t	kPrvCommandCallAllWatchCallBridge = 2
constexpr uint16_t	kPrvIndexWatchCall = 0x6000
constexpr uint32_t	kPrvLengthMessageWatchCall = 8
constexpr uint16_t	kPrvBroadcastNewAlarm = 0
constexpr uint16_t	kPrvBroadcastSoundOff = 1
constexpr uint16_t	kPrvBroadcastACK = 2
constexpr uint16_t	kPrvBroadcastStartArea = 4
constexpr uint16_t	kPrvIndexCommandChannelOffset = 0x3800
constexpr uint16_t	kPrvOffsetCmd = 400
constexpr uint16_t	kPrvOffsetInternMemory = 500
constexpr uint32_t	kPrvLengthMessageBroadCastSoundOff = 8
constexpr uint16_t	MAX_ANALOG_INPUT_INDEX = 0x363
constexpr std::string_view	kPrvStrSend = "TO_SEND"

Enumeration Type Documentation

eBroadcastType

enum class iv::comms::can::eBroadcastType

strong

Enumerator
NewAlarm
SoundOff
SoundAck
SoundDeadMan

eMessageType

enum class iv::comms::can::eMessageType

strong

Enumerator
Heartbeat
AnalogInput
SlimStatusUpdate
Text
Alarm
Command
AlarmTimestamp
DigitalInput_0_63
DigitalInput_64_127
DigitalInput_128_191
LssSlave
LssMaster
SdoRequestFromClient
SdoResponseFromServer
AlarmGroupsStatus
NmtService
TimestampSync
HistorySync
HistoryAckSync
GmtSync
Undefined

Function Documentation

getIdUnitGlobal()

uint16_t iv::comms::can::getIdUnitGlobal ( uint16_t idUnitLocal, uint16_t idSubnetwork )

inline

getIdUnitLocalAndSubnetwork()

void iv::comms::can::getIdUnitLocalAndSubnetwork ( iv::types::unitId idUnit, iv::types::unitId * idUnitLocal, iv::types::subnetwork * idSubnetwork )

inline

getMessageType()

iv::comms::can::eMessageType iv::comms::can::getMessageType ( const uint64_t msgId )

inline

getNumDaysAndMillisecondsSinceLOMBaseDate()

void iv::comms::can::getNumDaysAndMillisecondsSinceLOMBaseDate ( iv::types::timestamp now, uint16_t & daysSince1984, uint32_t & milliseconds )

inline

idTypeRepeaterByArea()

unsigned char iv::comms::can::idTypeRepeaterByArea ( iv::model::eShipArea eAreaShip )

inline

idUnitStation()

uint16_t iv::comms::can::idUnitStation ( uint16_t idStation )

inline

indexChannelBroadcastNewAlarm()

uint16_t iv::comms::can::indexChannelBroadcastNewAlarm ( iv::model::eShipArea stationArea )

inline

indexChannelBroadcastSoundOff()

uint16_t iv::comms::can::indexChannelBroadcastSoundOff ( iv::model::eShipArea stationArea )

inline

isBroadCastCommand()

bool iv::comms::can::isBroadCastCommand ( uint16_t indexChannel, iv::comms::can::eBroadcastType * typeBroadCast, uint16_t * typeZoneRepeaters )

inline

isEqualMessageCAN()

bool iv::comms::can::isEqualMessageCAN ( const iv::comms::can::CanDataMessage * message1, const iv::comms::can::CanDataMessage * message2 )

inline

isHeartbeatOk()

bool iv::comms::can::isHeartbeatOk ( const iv::comms::eHeartbeatState heartbeatState )

inline

isInHeartbeatCanIdRange()

bool iv::comms::can::isInHeartbeatCanIdRange ( const uint32_t canId )

inline

isInSdoResponseCanIdRange()

bool iv::comms::can::isInSdoResponseCanIdRange ( const uint32_t canId )

inline

isWatchCall()

bool iv::comms::can::isWatchCall ( uint16_t indexChannel, uint16_t * areaRepeater )

inline

prvGetIdLocalUnitAndSubnetwork()

void iv::comms::can::prvGetIdLocalUnitAndSubnetwork ( iv::types::unitId idUnit, iv::types::unitId * idLocalUnit, iv::types::subnetwork * idSubnetwork )

inline

prvIdUnitStation()

uint8_t iv::comms::can::prvIdUnitStation ( iv::types::unitId idStation )

inline

prvIndexChannelBroadCast()

uint16_t iv::comms::can::prvIndexChannelBroadCast ( iv::model::eShipArea areaStation, uint16_t typeBroadcast )

inline

prvReadNextDataSegment()

bool iv::comms::can::prvReadNextDataSegment ( const std::shared_ptr< iv::streams::IInputStream > & input, uint64_t & lengthDataLeft, char ** dataBuffer, const int64_t sizeSegments )

inline

Reads the next chars to be sent

Parameters

input
lengthDataLeft
dataBuffer	buffer to write read chars
sizeSegments	number of chars to read

Returns

if it's the last segment

Variable Documentation

kPrvAllNode

uint8_t iv::comms::can::kPrvAllNode = 0

constexpr

kPrvAllSubnetwork

uint16_t iv::comms::can::kPrvAllSubnetwork = 0xFFFF

constexpr

kPrvBroadcastACK

uint16_t iv::comms::can::kPrvBroadcastACK = 2

constexpr

kPrvBroadcastNewAlarm

uint16_t iv::comms::can::kPrvBroadcastNewAlarm = 0

constexpr

kPrvBroadcastSoundOff

uint16_t iv::comms::can::kPrvBroadcastSoundOff = 1

constexpr

kPrvBroadcastStartArea

uint16_t iv::comms::can::kPrvBroadcastStartArea = 4

constexpr

kPrvCommandACK

uint8_t iv::comms::can::kPrvCommandACK = 0x80

constexpr

kPrvCommandCallAllOff

uint8_t iv::comms::can::kPrvCommandCallAllOff = 0

constexpr

kPrvCommandCallAllWatchCallBridge

uint8_t iv::comms::can::kPrvCommandCallAllWatchCallBridge = 2

constexpr

kPrvCommandCallAllWatchCallEcr

uint8_t iv::comms::can::kPrvCommandCallAllWatchCallEcr = 1

constexpr

kPrvCommandCtrl

uint8_t iv::comms::can::kPrvCommandCtrl = 0x81

constexpr

kPrvCommandOnDutyWatchCall

uint8_t iv::comms::can::kPrvCommandOnDutyWatchCall = 0x01

constexpr

kPrvCommandPreOperationalNode

uint8_t iv::comms::can::kPrvCommandPreOperationalNode = 0x80

constexpr

kPrvCommandResetNode

uint8_t iv::comms::can::kPrvCommandResetNode = 0x81

constexpr

kPrvCommandStopNode

uint8_t iv::comms::can::kPrvCommandStopNode = 2

constexpr

kPrvFirstStation

uint8_t iv::comms::can::kPrvFirstStation = 119

constexpr

kPrvIndexCommandChannelOffset

uint16_t iv::comms::can::kPrvIndexCommandChannelOffset = 0x3800

constexpr

kPrvIndexWatchCall

uint16_t iv::comms::can::kPrvIndexWatchCall = 0x6000

constexpr

kPrvLengthMessageBroadCastSoundOff

uint32_t iv::comms::can::kPrvLengthMessageBroadCastSoundOff = 8

constexpr

kPrvLengthMessageWatchCall

uint32_t iv::comms::can::kPrvLengthMessageWatchCall = 8

constexpr

kPrvMaxModulesForSubnetwork

uint16_t iv::comms::can::kPrvMaxModulesForSubnetwork = 1000

constexpr

kPrvMaxNumberModulesInSubnetwork

uint16_t iv::comms::can::kPrvMaxNumberModulesInSubnetwork = 127

constexpr

kPrvOffsetCmd

uint16_t iv::comms::can::kPrvOffsetCmd = 400

constexpr

kPrvOffsetInternMemory

uint16_t iv::comms::can::kPrvOffsetInternMemory = 500

constexpr

kPrvStrSend

std::string_view iv::comms::can::kPrvStrSend = "TO_SEND"

constexpr

kPrvTypeRealValue

uint8_t iv::comms::can::kPrvTypeRealValue = 0x90

constexpr

kPrvTypeTextConcat

uint8_t iv::comms::can::kPrvTypeTextConcat = 0x00

constexpr

kPrvTypeTextFinish

uint8_t iv::comms::can::kPrvTypeTextFinish = 0x80

constexpr

kPrvTypeTextInit

uint8_t iv::comms::can::kPrvTypeTextInit = 0x40

constexpr

kPrvTypeTextPositionMask

uint8_t iv::comms::can::kPrvTypeTextPositionMask = 0x3F

constexpr

kPrvTypeTextStateMask

uint8_t iv::comms::can::kPrvTypeTextStateMask = 0xC0

constexpr

kPrvUnitIdMask

uint32_t iv::comms::can::kPrvUnitIdMask = 0x07F

constexpr

MAX_ANALOG_INPUT_INDEX

uint16_t iv::comms::can::MAX_ANALOG_INPUT_INDEX = 0x363

constexpr