iv::comms Namespace Reference

Namespaces
namespace	api
namespace	apis
namespace	can
namespace	canJ1939
namespace	ip
namespace	ixxat
namespace	modbus
namespace	nmea0183
namespace	nmea2k
namespace	redundancy
namespace	serial
namespace	socket
namespace	socketcan
namespace	vdr
namespace	watchcallNT

Classes
class	CommunicationCenter
class	ICommunicationController
class	ICommunicationDriver
class	ICommunicationProtocol
class	IMessageComm
class	LomOperator
class	ParametersDownloadFactory
class	ParametersDownloadManager
class	ProjectSynchronization

Enumerations
enum class	eProjectSynchronizationType {   REQUEST_DATA_PROJECT = 0 , REQUEST_FULL_PROJECT = 1 , SYNC_NOTIFICATION = 2 , RESTORE_NOTIFICATION = 3 ,   RESTORE_REQUEST_PROJECT = 4 }
	Tipos de petición de sincronización de proyecto. More...
enum class	receptionMode { SDO = 0 , LSS = 1 }
enum class	eDownloadMode { Simultaneous , Consecutive }
enum class	eDownloadScope { ChannelsAndLogics , OnlyChannels , OnlyLogics }
enum class	eLomLine {   LineA = 0 , LineB = 1 , LineC = 2 , WatchCallA = 3 ,   WatchCallB = 4 }
enum class	eInterfaceType {   Ethernet , Http , IxxatUsbV1 , PCanGateway ,   SocketCan , SerialLine }
enum class	eNetworkType {   Lom , Redundancy , Vdr , WatchCall ,   External , Api }
enum class	eProtocolType {   Can , J1939 , Nmea2k , Modbus ,   Nmea0183 , Vdr , Redundancy , Loggers ,   WatchcallNT }
enum class	eCommDebugLevels { OnlyCritical , ErrorOrHigher , WarningOrHigher , All }
enum class	eResponse {   Ok , Timeout , ConnectionError , FullError ,   NoMessage , MessageError , MessageInvalid , MessageNotAllowed }
enum class	eHeartbeatState {   BootUp = 0 , Offline = 255 , Operational = 5 , PreOperational = 127 ,   Stopped = 4 }
enum class	eMessageDirection { Incoming , Outgoing }

Functions
bool	isUserFromArea (const iv::diamar::eUserProfileType userProfileType, const iv::channels::eChannelArea area)
static void	addDownloadLoggerLog (const std::optional< std::shared_ptr< iv::logs::IDownloadLogger > > &logger, const std::string_view logTitle, const std::string_view logMessage, const iv::logs::eDownloadLogState logState)
static std::optional< std::shared_ptr< iv::logs::IDownloadLogger > >	addDownloadLoggerSubLog (const std::optional< std::shared_ptr< iv::logs::IDownloadLogger > > &logger, const std::string_view logTitle, const std::string_view logMessage, const iv::logs::eDownloadLogState logState)
static void	addProgressLog (const std::optional< std::shared_ptr< AbstractProgress > > &progress, const std::string_view logMessage)
uint8_t	createInitiatedDomainCommand (const uint8_t sizeIndicator, const uint8_t expeditedTransfer, const uint8_t numByteWithoutData, const uint8_t empty, const uint8_t protocolSDO)
bool	getNextSegment (const std::shared_ptr< iv::streams::InputStreamMemory > &data, std::vector< std::byte > &dataToSend)
uint8_t	createDomainSegmentCommand (const uint8_t lastSegment, const uint8_t numByteWithoutData, const uint8_t toggle, const uint8_t protocolSDO)
float	getLimitValue (const bool enabled, const float value)
uint8_t	createDomainSegmentUploadHeader (const bool toggle)
bool	isLastSegment (const uint8_t command)
uint8_t	getFreeBytes (const uint8_t command)
std::string	cleanString (const std::string &input)
bool	isNetworkValidAsFallbackNetwork (iv::comms::eNetworkType networkType, iv::comms::eInterfaceType interfaceType, iv::comms::eProtocolType protocolType)

Enumeration Type Documentation

eCommDebugLevels

enum class iv::comms::eCommDebugLevels

strong

Specifies which logs are actually stored by the system for a given comm

Note

: The order of priorities goes as follows: Critical > Error > Warning > Info

Enumerator
OnlyCritical
ErrorOrHigher
WarningOrHigher
All

eDownloadMode

enum class iv::comms::eDownloadMode

strong

Enumerator
Simultaneous
Consecutive

eDownloadScope

enum class iv::comms::eDownloadScope

strong

Enumerator
ChannelsAndLogics
OnlyChannels
OnlyLogics

eHeartbeatState

enum class iv::comms::eHeartbeatState

strong

Enumerator
BootUp
Offline
Operational
PreOperational
Stopped

eInterfaceType

enum class iv::comms::eInterfaceType

strong

Enumerator
Ethernet
Http
IxxatUsbV1
PCanGateway
SocketCan
SerialLine

eLomLine

enum class iv::comms::eLomLine

strong

Enumerator
LineA
LineB
LineC
WatchCallA
WatchCallB

eMessageDirection

enum class iv::comms::eMessageDirection

strong

Enumerator
Incoming
Outgoing

eNetworkType

enum class iv::comms::eNetworkType

strong

Enumerator
Lom
Redundancy
Vdr
WatchCall
External
Api

eProjectSynchronizationType

enum class iv::comms::eProjectSynchronizationType

strong

Tipos de petición de sincronización de proyecto.

Enumerator
REQUEST_DATA_PROJECT	Petición de sincronización de proyecto. Note Se envía el DataProject completo por el socket
REQUEST_FULL_PROJECT	Petición de sincronización de proyecto completo, Mimicos, Logicas, Tanques, Configuración, etc.
SYNC_NOTIFICATION	Notificación de sincronización de proyecto. Note Al recibirse esta petición, se ejecuta la función de sincronización de proyecto
RESTORE_NOTIFICATION	Notificación de restore de la aplicación. Note Se debe enviar al completar una restauración de la aplicación con un backup. Al recibirse esta petición, se sincroniza el proyecto y reinicia.
RESTORE_REQUEST_PROJECT	Petición de sincronización de proyecto completo para una restauración. Note Se debe enviar cuando recibes un RESTORE_NOTIFICATION, por el cual una estación te ha alertado de que hay una posible restauración. Al recibirse esta petición, quiere decir que una estación requiere tus datos para restaurarse. Respondes enviando tu Project.

eProtocolType

enum class iv::comms::eProtocolType

strong

Enumerator
Can
J1939
Nmea2k
Modbus
Nmea0183
Vdr
Redundancy
Loggers
WatchcallNT

eResponse

enum class iv::comms::eResponse

strong

Enumerator
Ok
Timeout
ConnectionError
FullError
NoMessage
MessageError
MessageInvalid
MessageNotAllowed

receptionMode

enum class iv::comms::receptionMode

strong

Enumerator
SDO
LSS

Function Documentation

addDownloadLoggerLog()

static void iv::comms::addDownloadLoggerLog ( const std::optional< std::shared_ptr< iv::logs::IDownloadLogger > > & logger, const std::string_view logTitle, const std::string_view logMessage, const iv::logs::eDownloadLogState logState )

static

addDownloadLoggerSubLog()

static std::optional< std::shared_ptr< iv::logs::IDownloadLogger > > iv::comms::addDownloadLoggerSubLog ( const std::optional< std::shared_ptr< iv::logs::IDownloadLogger > > & logger, const std::string_view logTitle, const std::string_view logMessage, const iv::logs::eDownloadLogState logState )

static

addProgressLog()

static void iv::comms::addProgressLog ( const std::optional< std::shared_ptr< AbstractProgress > > & progress, const std::string_view logMessage )

static

cleanString()

std::string iv::comms::cleanString

(

const std::string &

input

)

createDomainSegmentCommand()

uint8_t iv::comms::createDomainSegmentCommand	(	const uint8_t	lastSegment,
		const uint8_t	numByteWithoutData,
		const uint8_t	toggle,
		const uint8_t	protocolSDO )

createDomainSegmentUploadHeader()

uint8_t iv::comms::createDomainSegmentUploadHeader

(

const bool

toggle

)

createInitiatedDomainCommand()

uint8_t iv::comms::createInitiatedDomainCommand	(	const uint8_t	sizeIndicator,
		const uint8_t	expeditedTransfer,
		const uint8_t	numByteWithoutData,
		const uint8_t	empty,
		const uint8_t	protocolSDO )

getFreeBytes()

uint8_t iv::comms::getFreeBytes

(

const uint8_t

command

)

getLimitValue()

float iv::comms::getLimitValue	(	const bool	enabled,
		const float	value )

getNextSegment()

bool iv::comms::getNextSegment	(	const std::shared_ptr< iv::streams::InputStreamMemory > &	data,
		std::vector< std::byte > &	dataToSend )

isLastSegment()

bool iv::comms::isLastSegment

(

const uint8_t

command

)

isNetworkValidAsFallbackNetwork()

bool iv::comms::isNetworkValidAsFallbackNetwork ( iv::comms::eNetworkType networkType, iv::comms::eInterfaceType interfaceType, iv::comms::eProtocolType protocolType )

inline

isUserFromArea()

bool iv::comms::isUserFromArea ( const iv::diamar::eUserProfileType userProfileType, const iv::channels::eChannelArea area )

inline