Nix (Dev) 3.5.10
dev - 3.5.10 - 1af9301
Loading...
Searching...
No Matches
iv::comms::can::CanMessageFactory Class Reference

#include <CanMessageFactory.hpp>

Static Public Member Functions

static CMessageCanreadMessageCAN (const std::shared_ptr< iv::streams::IInputStream > &inputStream, const std::string &sourceId="FILE")
 
static void readMessageCAN (const std::shared_ptr< iv::streams::IInputStream > &inputMessage, iv::types::timestamp *timestamp, uint32_t *msgId, uint8_t bytes[8], uint32_t *lengthMessage, bool *isRTR, iv::types::subnetwork *idSubnetwork, uint32_t *lengthMessageExtra, uint8_t **bytesExtra, bool *isExtended)
 
static void writeMessageCAN (const std::shared_ptr< iv::streams::IOutputStream > &output, uint32_t timestamp, uint32_t msgId, const uint8_t bytes[8], uint32_t lengthMessage, bool isRTR, iv::types::subnetwork idSubnetwork, uint32_t lengthMessageExtra, const uint8_t *bytesExtra)
 
static CMessageCancreateMessage (const std::string &source, uint64_t msgIdAndUnitLocal, const uint8_t bytes[8], uint64_t timeStamp, uint64_t lengthData, bool isRTR, uint16_t idSubnetwork, uint64_t lengthDataExtra, uint8_t **bytesDataExtra, bool isExtended)
 
static CMessageCancreateMessageQuerySdoClient (iv::types::unitId idUnit, const uint8_t bytes[8], uint64_t lengthData)
 
static CMessageCancreateMasterCommandLss (uint8_t cmdLSS)
 
static CMessageCancreateMasterCommandLssData (uint8_t cmdLSS, uint8_t data)
 
static CMessageCancreateNmtSetPreOperationalUnit (iv::types::unitId idUnit)
 
static CMessageCancreateNmtStartAllUnit ()
 
static CMessageCancreateNmtStartUnit (uint32_t idUnit)
 
static CMessageCancreateNmtStopAllUnit ()
 
static CMessageCancreateNmtStopUnit (uint16_t idUnit)
 
static CMessageCancreateCallAll (iv::types::unitId idStation, uint16_t zoneRepeaters, bool isCalling)
 
static CMessageCancreateCommandWatchCall (iv::types::unitId stationUnitId, uint16_t idRepeater, uint8_t command, uint8_t value)
 
static CMessageCancreateOnDuty (iv::types::unitId idStation, uint16_t idRepeater, bool isOnDuty)
 
static CMessageCancreateUpdateWatchCall (iv::types::unitId idStation, uint16_t zoneRepeaters, uint64_t watchCallState)
 
static CMessageCancreateHistorySynchronize (iv::types::unitId idUnit, iv::types::stationId idStation, uint16_t indexChannel, uint8_t typeAlarmAndStatus, uint64_t time, float valueAlarm)
 
static CMessageCancreateHistoryAckSynchronize (iv::types::unitId idUnit, iv::types::stationId idStation, uint16_t indexChannel, uint8_t typeAlarmAndStatus, uint64_t time, float valueAlarm)
 
static CMessageCancreateValueAnalogFloat (uint16_t idUnit, uint16_t indexChannel, float value)
 
static CMessageCancreateValueAnalogULong (uint16_t idUnit, uint16_t indexChannel, uint32_t value)
 
static CMessageCancreateValueAnalogULongReversed (uint16_t idUnit, uint16_t indexChannel, uint32_t value)
 
static CMessageCancreateSegmentString (uint16_t idUnit, uint16_t indexChannel, const char *value, uint64_t sizeValue, uint8_t segmentPosition, bool isLastSegment)
 Creates a string msg segment to be sent.
 
static std::shared_ptr< CMessageCancreateAck (uint16_t idUnit, uint16_t indexChannel)
 
static CMessageCancreateCommand (uint16_t idUnitSource, uint16_t idUnitDest, uint16_t indexChannel, uint8_t command, uint64_t value)
 
static CMessageCancreateCommandCtrl (uint32_t idUnit, uint16_t indexChannel, uint64_t value)
 
static CMessageCancreateCommandSetAnalogOutput (uint16_t idUnit, uint16_t indexChannel, uint64_t value)
 
static CMessageCancreateTimeStamp (uint16_t numDaysSince1984, uint32_t numMilliseconds1984)
 
static CMessageCancreateUpdateGroupsInAlarm (iv::types::unitId idStation, const void *buffer, uint64_t numBytes)
 
static CMessageCancreateBroadcastAck (iv::model::eShipArea areaStation)
 
static CMessageCancreateBroadcastNewAlarm (iv::model::eShipArea areaStation)
 
static std::shared_ptr< CMessageCancreateSoundOff (iv::model::eShipArea areaStation)
 
static CMessageCancreateAlarm (iv::types::unitId idUnit, uint16_t idChannelIndex, const iv::types::groupId &idGroup, uint8_t typeAlarm, float valueEventAlarm)
 
static CMessageCancreateTimestampAlarm (iv::types::unitId idUnit, uint16_t indexChannel, const iv::types::groupId &idGroup, uint16_t numDaysSince1984, uint64_t milliseconds)
 
static CMessageCancreateMessageSynchronizeTimeUtc (const iv::types::unitId &idStation, int16_t offsetGMT, uint64_t timeUTC)
 
static CMessageCancreateUpdateAlarmSignal (uint16_t idUnit)
 
static CMessageCancreateUpdateAnalogSignal (uint16_t idUnit)
 
static CMessageCancreateUpdateStationDigitalSignal (uint16_t idUnit)
 
static CMessageCancreateUpdateGroupAlarmStates (iv::types::unitId stationUnitId, uint64_t groupAlarmStates)
 
static void writeValuesDataMessageAlarm (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint16_t indexChannel, uint8_t idGroupForLoms, uint8_t typeAlarm, float valueAlarm)
 WRITE DATAS.
 
static void writeValuesDataMessageAlarmTimestamp (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint16_t indexChannel, uint16_t numDaysSince1984, uint32_t milliseconds)
 
static void writeValuesDataMessageTimestamp (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint16_t numDaysSince1984, uint32_t numMilliseconds1984)
 
static void writeValuesDataMessageAnalogInput (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, iv::types::unitId idUnit, uint16_t indexChannel, uint8_t typeData, uint32_t value)
 
static void writeValuesDataMessageText (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint8_t idUnit, uint16_t indexChannel, const char *value, uint64_t sizeValue, uint8_t segmentPosition, bool isLastSegment)
 
static void writeValuesDataMessageCommand (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint8_t idUnitLocalDest, uint16_t indexChannel, uint8_t command, uint32_t value)
 
static void writeValuesDataMessageCommandBool (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint8_t idUnitLocalDest, uint16_t indexChannel, uint8_t command, bool value)
 
static void writeValuesDataMessageCommandChar (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint8_t idUnitLocalDest, uint16_t indexChannel, uint8_t command, uint8_t value)
 
static void writeValuesDataMessageGmtSync (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint8_t idUnitStation, int8_t offsetGMT, uint32_t timeUTC)
 
static void writeValuesDataMessageHeartbeat (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, iv::comms::eHeartbeatState heartbeatState, uint8_t heartbeatType)
 
static void writeValuesDataMessageHistorySync (const std::shared_ptr< iv::streams::OutputStreamMemory > &output, const iv::types::stationId &idStation, uint16_t indexChannel, uint8_t typeAlarmAndStatus, iv::types::timestamp time, float valueAlarm)
 
static CMessageCancreateStationHeartbeat (types::unitId stationUnitId)
 

Static Private Member Functions

static CMessageCanprvCreateBroadcast (iv::model::eShipArea areaStation, uint16_t typeBroadcast)
 
static CMessageCanprvCreateCommand (iv::types::unitId idUnit, iv::types::unitId idUnitDest, uint16_t indexChannel, uint8_t command, uint64_t value)
 
static CMessageCanprvCreateHistorySynchronize (uint64_t msgId, iv::types::unitId idUnit, const iv::types::stationId &idStation, uint16_t indexChannel, uint8_t typeAlarmAndStatus, uint64_t time, float valueAlarm)
 
static CMessageCanprvCreateMessageDefault (std::string_view source, uint32_t msgId, iv::types::unitId idUnitLocal, const uint8_t bytes[8], iv::types::timestamp timeStamp, uint32_t lengthData, bool isRTR, iv::types::subnetwork idSubnetwork)
 
static CMessageCanprvCreateMessageDefault2 (uint64_t cobId, iv::types::unitId idUnitLocal, const std::shared_ptr< iv::streams::OutputStreamMemory > &output, uint64_t sizeMessage, iv::types::subnetwork idSubnetwork)
 
static CMessageCanprvCreateMessageWithBytesExtra (std::string_view source, uint64_t msgId, iv::types::unitId idUnitLocal, const uint8_t *bytes, iv::types::timestamp timeStamp, uint64_t lengthData, iv::types::subnetwork idSubnetwork)
 
static CMessageCanprvCreateMsgNmt (iv::types::unitId idUnitInSubnetwork, iv::types::subnetwork idSubnetwork, uint8_t commandSpec)
 
static CMessageCanprvCreateValueAnalogULong (uint32_t idUnit, uint16_t indexChannel, uint32_t value)
 

Member Function Documentation

◆ createAck()

std::shared_ptr< CMessageCan > iv::comms::can::CanMessageFactory::createAck ( uint16_t idUnit,
uint16_t indexChannel )
static

◆ createAlarm()

CMessageCan * iv::comms::can::CanMessageFactory::createAlarm ( iv::types::unitId idUnit,
uint16_t idChannelIndex,
const iv::types::groupId & idGroup,
uint8_t typeAlarm,
float valueEventAlarm )
static

◆ createBroadcastAck()

CMessageCan * iv::comms::can::CanMessageFactory::createBroadcastAck ( iv::model::eShipArea areaStation)
static

◆ createBroadcastNewAlarm()

CMessageCan * iv::comms::can::CanMessageFactory::createBroadcastNewAlarm ( iv::model::eShipArea areaStation)
static

◆ createCallAll()

CMessageCan * iv::comms::can::CanMessageFactory::createCallAll ( iv::types::unitId idStation,
uint16_t zoneRepeaters,
bool isCalling )
static

◆ createCommand()

CMessageCan * iv::comms::can::CanMessageFactory::createCommand ( uint16_t idUnitSource,
uint16_t idUnitDest,
uint16_t indexChannel,
uint8_t command,
uint64_t value )
static

◆ createCommandCtrl()

CMessageCan * iv::comms::can::CanMessageFactory::createCommandCtrl ( uint32_t idUnit,
uint16_t indexChannel,
uint64_t value )
static

◆ createCommandSetAnalogOutput()

CMessageCan * iv::comms::can::CanMessageFactory::createCommandSetAnalogOutput ( uint16_t idUnit,
uint16_t indexChannel,
uint64_t value )
static

◆ createCommandWatchCall()

CMessageCan * iv::comms::can::CanMessageFactory::createCommandWatchCall ( iv::types::unitId stationUnitId,
uint16_t idRepeater,
uint8_t command,
uint8_t value )
static

◆ createHistoryAckSynchronize()

CMessageCan * iv::comms::can::CanMessageFactory::createHistoryAckSynchronize ( iv::types::unitId idUnit,
iv::types::stationId idStation,
uint16_t indexChannel,
uint8_t typeAlarmAndStatus,
uint64_t time,
float valueAlarm )
static

◆ createHistorySynchronize()

CMessageCan * iv::comms::can::CanMessageFactory::createHistorySynchronize ( iv::types::unitId idUnit,
iv::types::stationId idStation,
uint16_t indexChannel,
uint8_t typeAlarmAndStatus,
uint64_t time,
float valueAlarm )
static

◆ createMasterCommandLss()

CMessageCan * iv::comms::can::CanMessageFactory::createMasterCommandLss ( uint8_t cmdLSS)
static

◆ createMasterCommandLssData()

CMessageCan * iv::comms::can::CanMessageFactory::createMasterCommandLssData ( uint8_t cmdLSS,
uint8_t data )
static

◆ createMessage()

CMessageCan * iv::comms::can::CanMessageFactory::createMessage ( const std::string & source,
uint64_t msgIdAndUnitLocal,
const uint8_t bytes[8],
uint64_t timeStamp,
uint64_t lengthData,
bool isRTR,
uint16_t idSubnetwork,
uint64_t lengthDataExtra,
uint8_t ** bytesDataExtra,
bool isExtended )
static

◆ createMessageQuerySdoClient()

CMessageCan * iv::comms::can::CanMessageFactory::createMessageQuerySdoClient ( iv::types::unitId idUnit,
const uint8_t bytes[8],
uint64_t lengthData )
static

◆ createMessageSynchronizeTimeUtc()

CMessageCan * iv::comms::can::CanMessageFactory::createMessageSynchronizeTimeUtc ( const iv::types::unitId & idStation,
int16_t offsetGMT,
uint64_t timeUTC )
static

◆ createNmtSetPreOperationalUnit()

CMessageCan * iv::comms::can::CanMessageFactory::createNmtSetPreOperationalUnit ( iv::types::unitId idUnit)
static

◆ createNmtStartAllUnit()

CMessageCan * iv::comms::can::CanMessageFactory::createNmtStartAllUnit ( )
static

◆ createNmtStartUnit()

CMessageCan * iv::comms::can::CanMessageFactory::createNmtStartUnit ( uint32_t idUnit)
static

◆ createNmtStopAllUnit()

CMessageCan * iv::comms::can::CanMessageFactory::createNmtStopAllUnit ( )
static

◆ createNmtStopUnit()

CMessageCan * iv::comms::can::CanMessageFactory::createNmtStopUnit ( uint16_t idUnit)
static

◆ createOnDuty()

CMessageCan * iv::comms::can::CanMessageFactory::createOnDuty ( iv::types::unitId idStation,
uint16_t idRepeater,
bool isOnDuty )
static

◆ createSegmentString()

CMessageCan * iv::comms::can::CanMessageFactory::createSegmentString ( uint16_t idUnit,
uint16_t indexChannel,
const char * value,
uint64_t sizeValue,
uint8_t segmentPosition,
bool isLastSegment )
static

Creates a string msg segment to be sent.

Parameters
idUnit
indexChannel
valuestring value to be sent
sizeValuenumber of characters of the string segment
segmentPositionposition of the segment in the whole msg
isLastSegmentif it's final segment
Returns
Can message with the string segment

◆ createSoundOff()

std::shared_ptr< CMessageCan > iv::comms::can::CanMessageFactory::createSoundOff ( iv::model::eShipArea areaStation)
static

◆ createStationHeartbeat()

CMessageCan * iv::comms::can::CanMessageFactory::createStationHeartbeat ( types::unitId stationUnitId)
static

◆ createTimeStamp()

CMessageCan * iv::comms::can::CanMessageFactory::createTimeStamp ( uint16_t numDaysSince1984,
uint32_t numMilliseconds1984 )
static

◆ createTimestampAlarm()

CMessageCan * iv::comms::can::CanMessageFactory::createTimestampAlarm ( iv::types::unitId idUnit,
uint16_t indexChannel,
const iv::types::groupId & idGroup,
uint16_t numDaysSince1984,
uint64_t milliseconds )
static

◆ createUpdateAlarmSignal()

CMessageCan * iv::comms::can::CanMessageFactory::createUpdateAlarmSignal ( uint16_t idUnit)
static

◆ createUpdateAnalogSignal()

CMessageCan * iv::comms::can::CanMessageFactory::createUpdateAnalogSignal ( uint16_t idUnit)
static

◆ createUpdateGroupAlarmStates()

CMessageCan * iv::comms::can::CanMessageFactory::createUpdateGroupAlarmStates ( iv::types::unitId stationUnitId,
uint64_t groupAlarmStates )
static

◆ createUpdateGroupsInAlarm()

CMessageCan * iv::comms::can::CanMessageFactory::createUpdateGroupsInAlarm ( iv::types::unitId idStation,
const void * buffer,
uint64_t numBytes )
static

◆ createUpdateStationDigitalSignal()

CMessageCan * iv::comms::can::CanMessageFactory::createUpdateStationDigitalSignal ( uint16_t idUnit)
static

◆ createUpdateWatchCall()

CMessageCan * iv::comms::can::CanMessageFactory::createUpdateWatchCall ( iv::types::unitId idStation,
uint16_t zoneRepeaters,
uint64_t watchCallState )
static

◆ createValueAnalogFloat()

CMessageCan * iv::comms::can::CanMessageFactory::createValueAnalogFloat ( uint16_t idUnit,
uint16_t indexChannel,
float value )
static

◆ createValueAnalogULong()

CMessageCan * iv::comms::can::CanMessageFactory::createValueAnalogULong ( uint16_t idUnit,
uint16_t indexChannel,
uint32_t value )
static

◆ createValueAnalogULongReversed()

CMessageCan * iv::comms::can::CanMessageFactory::createValueAnalogULongReversed ( uint16_t idUnit,
uint16_t indexChannel,
uint32_t value )
static

◆ prvCreateBroadcast()

CMessageCan * iv::comms::can::CanMessageFactory::prvCreateBroadcast ( iv::model::eShipArea areaStation,
uint16_t typeBroadcast )
staticprivate

◆ prvCreateCommand()

CMessageCan * iv::comms::can::CanMessageFactory::prvCreateCommand ( iv::types::unitId idUnit,
iv::types::unitId idUnitDest,
uint16_t indexChannel,
uint8_t command,
uint64_t value )
staticprivate

◆ prvCreateHistorySynchronize()

CMessageCan * iv::comms::can::CanMessageFactory::prvCreateHistorySynchronize ( uint64_t msgId,
iv::types::unitId idUnit,
const iv::types::stationId & idStation,
uint16_t indexChannel,
uint8_t typeAlarmAndStatus,
uint64_t time,
float valueAlarm )
staticprivate

◆ prvCreateMessageDefault()

CMessageCan * iv::comms::can::CanMessageFactory::prvCreateMessageDefault ( std::string_view source,
uint32_t msgId,
iv::types::unitId idUnitLocal,
const uint8_t bytes[8],
iv::types::timestamp timeStamp,
uint32_t lengthData,
bool isRTR,
iv::types::subnetwork idSubnetwork )
staticprivate

◆ prvCreateMessageDefault2()

CMessageCan * iv::comms::can::CanMessageFactory::prvCreateMessageDefault2 ( uint64_t cobId,
iv::types::unitId idUnitLocal,
const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint64_t sizeMessage,
iv::types::subnetwork idSubnetwork )
staticprivate

◆ prvCreateMessageWithBytesExtra()

CMessageCan * iv::comms::can::CanMessageFactory::prvCreateMessageWithBytesExtra ( std::string_view source,
uint64_t msgId,
iv::types::unitId idUnitLocal,
const uint8_t * bytes,
iv::types::timestamp timeStamp,
uint64_t lengthData,
iv::types::subnetwork idSubnetwork )
staticprivate

◆ prvCreateMsgNmt()

CMessageCan * iv::comms::can::CanMessageFactory::prvCreateMsgNmt ( iv::types::unitId idUnitInSubnetwork,
iv::types::subnetwork idSubnetwork,
uint8_t commandSpec )
staticprivate

◆ prvCreateValueAnalogULong()

CMessageCan * iv::comms::can::CanMessageFactory::prvCreateValueAnalogULong ( uint32_t idUnit,
uint16_t indexChannel,
uint32_t value )
staticprivate

◆ readMessageCAN() [1/2]

void iv::comms::can::CanMessageFactory::readMessageCAN ( const std::shared_ptr< iv::streams::IInputStream > & inputMessage,
iv::types::timestamp * timestamp,
uint32_t * msgId,
uint8_t bytes[8],
uint32_t * lengthMessage,
bool * isRTR,
iv::types::subnetwork * idSubnetwork,
uint32_t * lengthMessageExtra,
uint8_t ** bytesExtra,
bool * isExtended )
static

◆ readMessageCAN() [2/2]

CMessageCan * iv::comms::can::CanMessageFactory::readMessageCAN ( const std::shared_ptr< iv::streams::IInputStream > & inputStream,
const std::string & sourceId = "FILE" )
static

◆ writeMessageCAN()

void iv::comms::can::CanMessageFactory::writeMessageCAN ( const std::shared_ptr< iv::streams::IOutputStream > & output,
uint32_t timestamp,
uint32_t msgId,
const uint8_t bytes[8],
uint32_t lengthMessage,
bool isRTR,
iv::types::subnetwork idSubnetwork,
uint32_t lengthMessageExtra,
const uint8_t * bytesExtra )
static

◆ writeValuesDataMessageAlarm()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageAlarm ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint16_t indexChannel,
uint8_t idGroupForLoms,
uint8_t typeAlarm,
float valueAlarm )
static

WRITE DATAS.

◆ writeValuesDataMessageAlarmTimestamp()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageAlarmTimestamp ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint16_t indexChannel,
uint16_t numDaysSince1984,
uint32_t milliseconds )
static

◆ writeValuesDataMessageAnalogInput()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageAnalogInput ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
iv::types::unitId idUnit,
uint16_t indexChannel,
uint8_t typeData,
uint32_t value )
static

◆ writeValuesDataMessageCommand()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageCommand ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint8_t idUnitLocalDest,
uint16_t indexChannel,
uint8_t command,
uint32_t value )
static

◆ writeValuesDataMessageCommandBool()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageCommandBool ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint8_t idUnitLocalDest,
uint16_t indexChannel,
uint8_t command,
bool value )
static

◆ writeValuesDataMessageCommandChar()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageCommandChar ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint8_t idUnitLocalDest,
uint16_t indexChannel,
uint8_t command,
uint8_t value )
static

◆ writeValuesDataMessageGmtSync()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageGmtSync ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint8_t idUnitStation,
int8_t offsetGMT,
uint32_t timeUTC )
static

◆ writeValuesDataMessageHeartbeat()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageHeartbeat ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
iv::comms::eHeartbeatState heartbeatState,
uint8_t heartbeatType )
static

◆ writeValuesDataMessageHistorySync()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageHistorySync ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
const iv::types::stationId & idStation,
uint16_t indexChannel,
uint8_t typeAlarmAndStatus,
iv::types::timestamp time,
float valueAlarm )
static

◆ writeValuesDataMessageText()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageText ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint8_t idUnit,
uint16_t indexChannel,
const char * value,
uint64_t sizeValue,
uint8_t segmentPosition,
bool isLastSegment )
static

◆ writeValuesDataMessageTimestamp()

void iv::comms::can::CanMessageFactory::writeValuesDataMessageTimestamp ( const std::shared_ptr< iv::streams::OutputStreamMemory > & output,
uint16_t numDaysSince1984,
uint32_t numMilliseconds1984 )
static

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