#include <EnumDataFlowParameter.hpp>

Public Types
enum class	eParameterJ1939 { Type , Pgn , SourceAddress , Spn , DataType , ExtraIdentifier }

enum class	eParameterModbus { Description , Direction , Type , IsExtended , Address , DataType , EndianType , RegisterBitsLength , BitPosition , SlaveId }

enum class	eParameterNmea0183 { Description , Header , FieldPosition , FieldType }

enum class	eParameterVdr { Description , id }

enum class	eParameterNmea2k { Pgn , SourceAddress , FieldPosition , DataType , ExtraIdentifier }

Static Public Member Functions
static std::string	getJ1939ParameterName (eParameterJ1939 param, bool shortName=true)
	Get the name of the parameter for the J1939 network.

static std::string	getJ1939ParameterColumnName (eParameterJ1939 param)
	Get the name of the parameter for the J1939 network to display in the column.

static uint16_t	getJ1939ParameterColumnWidth (eParameterJ1939 param)
	Get the width of the column in DataFlow's sheet for the J1939 network.

static uint16_t	getJ1939ParameterMaxChars (eParameterJ1939 param)
	Get the maximum number of characters for the parameter for the J1939 network.

static std::string	getJ1939ParameterValueAsString (const std::shared_ptr< INetworkInfo > &networkInfo, iv::channels::EnumDataFlowParameter::eParameterJ1939 param)
	Get the value for the parameter of the J1939 network as a string.

static std::string	getModbusParameterName (eParameterModbus param, bool shortName=true)
	Get the name of the parameter for the Modbus network.

static uint16_t	getModbusParameterColumnWidth (eParameterModbus param)
	Get the width of the column in DataFlow's sheet for the Modbus network.

static uint16_t	getModbusParameterMaxChars (eParameterModbus param)
	Get the width of the column in DataFlow's sheet for the Modbus network.

static std::string	getModbusParameterValueAsString (const std::shared_ptr< iv::channels::INetworkInfo > &networkInfo, const std::shared_ptr< iv::channels::AbstractChannel > &channel, iv::eLanguage language, eParameterModbus param)
	Get the value for the parameter of the Modbus network as a string.

static std::set< iv::comms::modbus::eRegisterType >	getModbusRegisterTypesForDirection (iv::channels::INetworkInfo::eDirection modbusRegisterDirection)
	Get the register types for the direction of the Modbus network.

static std::set< iv::eDataType >	getModbusDataTypesForRegisterType (iv::comms::modbus::eRegisterType modbusType)
	Get the data types for the register type of the Modbus network.

static std::string	getNmea0183ParameterName (eParameterNmea0183 param, bool shortName=true)
	Get the name of the parameter for the NMEA0183 network.

static uint16_t	getNmea0183ParameterMaxChars (eParameterNmea0183 param)
	Get the name of the parameter for the NMEA0183 network to display in the column.

static uint16_t	getNmea0183ParameterColumnWidth (eParameterNmea0183 param)
	Get the width of the column in DataFlow's sheet for the NMEA0183 network.

static std::string	getNmea0183ParameterValueAsString (const std::shared_ptr< iv::channels::INetworkInfo > &networkInfo, const std::shared_ptr< iv::channels::AbstractChannel > &channel, iv::eLanguage language, eParameterNmea0183 param)
	Get the value for the parameter of the NMEA0183 network as a string.

static std::string	getVdrParameterName (eParameterVdr param, bool shortName=true)

static uint16_t	getVdrParameterMaxChars (eParameterVdr param)

static uint16_t	getVdrParameterColumnWidth (eParameterVdr param)

static std::string	getVdrParameterValueAsString (const std::shared_ptr< iv::channels::INetworkInfo > &networkInfo, const std::shared_ptr< iv::channels::AbstractChannel > &channel, iv::eLanguage language, eParameterVdr param)

static std::string	getNmea2kParameterColumnName (eParameterNmea2k param)

static std::string	getNmea2kParameterName (eParameterNmea2k param, bool shortName=true)

static uint16_t	getNmea2kParameterMaxChars (eParameterNmea2k param)

static uint16_t	getNmea2kParameterColumnWidth (eParameterNmea2k param)

static std::string	getNmea2kParameterValueAsString (const std::shared_ptr< iv::channels::INetworkInfo > &networkInfo, eParameterNmea2k param)

Member Enumeration Documentation

◆ eParameterJ1939

enum class iv::channels::EnumDataFlowParameter::eParameterJ1939

strong

Enumerator
Type
Pgn
SourceAddress
Spn
DataType
ExtraIdentifier

◆ eParameterModbus

enum class iv::channels::EnumDataFlowParameter::eParameterModbus

strong

Enumerator
Description
Direction
Type
IsExtended
Address
DataType
EndianType
RegisterBitsLength
BitPosition
SlaveId

◆ eParameterNmea0183

enum class iv::channels::EnumDataFlowParameter::eParameterNmea0183

strong

Enumerator
Description
Header
FieldPosition
FieldType

◆ eParameterNmea2k

enum class iv::channels::EnumDataFlowParameter::eParameterNmea2k

strong

Enumerator
Pgn
SourceAddress
FieldPosition
DataType
ExtraIdentifier

◆ eParameterVdr

enum class iv::channels::EnumDataFlowParameter::eParameterVdr

strong

Enumerator
Description
id

Member Function Documentation

◆ getJ1939ParameterColumnName()

std::string iv::channels::EnumDataFlowParameter::getJ1939ParameterColumnName ( eParameterJ1939 param )

static

Get the name of the parameter for the J1939 network to display in the column.

Parameters

param The parameter to get the name.

Returns: The name of the parameter.

◆ getJ1939ParameterColumnWidth()

uint16_t iv::channels::EnumDataFlowParameter::getJ1939ParameterColumnWidth ( eParameterJ1939 param )

static

Get the width of the column in DataFlow's sheet for the J1939 network.

Parameters

param The parameter to get the width.

Returns: The width of the column.

◆ getJ1939ParameterMaxChars()

uint16_t iv::channels::EnumDataFlowParameter::getJ1939ParameterMaxChars ( eParameterJ1939 param )

static

Get the maximum number of characters for the parameter for the J1939 network.

Parameters

param The parameter to get the maximum number of characters.

Returns: The maximum number of characters.

◆ getJ1939ParameterName()

std::string iv::channels::EnumDataFlowParameter::getJ1939ParameterName	(	eParameterJ1939	param,
		bool	shortName = true )

static

Get the name of the parameter for the J1939 network.

Parameters

param	The parameter to get the name.
shortName	If short name is requested.

Returns: The name of the parameter.

◆ getJ1939ParameterValueAsString()

std::string iv::channels::EnumDataFlowParameter::getJ1939ParameterValueAsString	(	const std::shared_ptr< INetworkInfo > &	networkInfo,
		iv::channels::EnumDataFlowParameter::eParameterJ1939	param )

static

Get the value for the parameter of the J1939 network as a string.

Parameters

networkInfo	The network information.
param	The parameter to get the value.

Returns: The value of the parameter as a string.

◆ getModbusDataTypesForRegisterType()

std::set< iv::eDataType > iv::channels::EnumDataFlowParameter::getModbusDataTypesForRegisterType ( iv::comms::modbus::eRegisterType modbusType )

static

Get the data types for the register type of the Modbus network.

Parameters

modbusType The register type.

Returns: The data types for the register type.

◆ getModbusParameterColumnWidth()

uint16_t iv::channels::EnumDataFlowParameter::getModbusParameterColumnWidth ( eParameterModbus param )

static

Get the width of the column in DataFlow's sheet for the Modbus network.

Parameters

param The parameter to get the width.

Returns: The width of the column.

◆ getModbusParameterMaxChars()

uint16_t iv::channels::EnumDataFlowParameter::getModbusParameterMaxChars ( eParameterModbus param )

static

Get the width of the column in DataFlow's sheet for the Modbus network.

Parameters

param The parameter to get the width.

Returns: The width of the column.

◆ getModbusParameterName()

std::string iv::channels::EnumDataFlowParameter::getModbusParameterName	(	eParameterModbus	param,
		bool	shortName = true )

static

Get the name of the parameter for the Modbus network.

Parameters

param	The parameter to get the name.
shortName	If short name is requested.

Returns: The name of the parameter.

◆ getModbusParameterValueAsString()

std::string iv::channels::EnumDataFlowParameter::getModbusParameterValueAsString	(	const std::shared_ptr< iv::channels::INetworkInfo > &	networkInfo,
		const std::shared_ptr< iv::channels::AbstractChannel > &	channel,
		iv::eLanguage	language,
		eParameterModbus	param )

static

Get the value for the parameter of the Modbus network as a string.

Parameters

networkInfo	The network information.
param	The parameter to get the value.

Returns: The value of the parameter as a string.

◆ getModbusRegisterTypesForDirection()

std::set< iv::comms::modbus::eRegisterType > iv::channels::EnumDataFlowParameter::getModbusRegisterTypesForDirection ( iv::channels::INetworkInfo::eDirection modbusRegisterDirection )

static

Get the register types for the direction of the Modbus network.

Parameters

modbusRegisterDirection The direction of the register.

Returns: The register types for the direction.

◆ getNmea0183ParameterColumnWidth()

uint16_t iv::channels::EnumDataFlowParameter::getNmea0183ParameterColumnWidth ( eParameterNmea0183 param )

static

Get the width of the column in DataFlow's sheet for the NMEA0183 network.

Parameters

param The parameter to get the width.

Returns: The width of the column.

◆ getNmea0183ParameterMaxChars()

uint16_t iv::channels::EnumDataFlowParameter::getNmea0183ParameterMaxChars ( eParameterNmea0183 param )

static

Get the name of the parameter for the NMEA0183 network to display in the column.

Parameters

param The parameter to get the name.

Returns: The name of the parameter.

◆ getNmea0183ParameterName()

std::string iv::channels::EnumDataFlowParameter::getNmea0183ParameterName	(	eParameterNmea0183	param,
		bool	shortName = true )

static

Get the name of the parameter for the NMEA0183 network.

Parameters

param	The parameter to get the name.
shortName	If short name is requested.

Returns: The name of the parameter.

◆ getNmea0183ParameterValueAsString()

std::string iv::channels::EnumDataFlowParameter::getNmea0183ParameterValueAsString	(	const std::shared_ptr< iv::channels::INetworkInfo > &	networkInfo,
		const std::shared_ptr< iv::channels::AbstractChannel > &	channel,
		iv::eLanguage	language,
		eParameterNmea0183	param )

static

Get the value for the parameter of the NMEA0183 network as a string.

Parameters

networkInfo	The network information.
param	The parameter to get the value.

Returns: The value of the parameter as a string.

◆ getNmea2kParameterColumnName()

std::string iv::channels::EnumDataFlowParameter::getNmea2kParameterColumnName ( EnumDataFlowParameter::eParameterNmea2k param )

static

◆ getNmea2kParameterColumnWidth()

uint16_t iv::channels::EnumDataFlowParameter::getNmea2kParameterColumnWidth ( EnumDataFlowParameter::eParameterNmea2k param )

static

◆ getNmea2kParameterMaxChars()

uint16_t iv::channels::EnumDataFlowParameter::getNmea2kParameterMaxChars ( EnumDataFlowParameter::eParameterNmea2k param )

static

◆ getNmea2kParameterName()

std::string iv::channels::EnumDataFlowParameter::getNmea2kParameterName	(	EnumDataFlowParameter::eParameterNmea2k	param,
		bool	shortName = true )

static

◆ getNmea2kParameterValueAsString()

std::string iv::channels::EnumDataFlowParameter::getNmea2kParameterValueAsString	(	const std::shared_ptr< iv::channels::INetworkInfo > &	networkInfo,
		EnumDataFlowParameter::eParameterNmea2k	param )

static

◆ getVdrParameterColumnWidth()

uint16_t iv::channels::EnumDataFlowParameter::getVdrParameterColumnWidth ( EnumDataFlowParameter::eParameterVdr param )

static

◆ getVdrParameterMaxChars()

uint16_t iv::channels::EnumDataFlowParameter::getVdrParameterMaxChars ( EnumDataFlowParameter::eParameterVdr param )

static

◆ getVdrParameterName()

std::string iv::channels::EnumDataFlowParameter::getVdrParameterName	(	EnumDataFlowParameter::eParameterVdr	param,
		bool	shortName = true )

static

◆ getVdrParameterValueAsString()

std::string iv::channels::EnumDataFlowParameter::getVdrParameterValueAsString	(	const std::shared_ptr< iv::channels::INetworkInfo > &	networkInfo,
		const std::shared_ptr< iv::channels::AbstractChannel > &	channel,
		iv::eLanguage	language,
		EnumDataFlowParameter::eParameterVdr	param )

static

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

src/channels/EnumDataFlowParameter.hpp
src/channels/EnumDataFlowParameter.cpp

Public Types

Static Public Member Functions

Member Enumeration Documentation

◆ eParameterJ1939

◆ eParameterModbus

◆ eParameterNmea0183

◆ eParameterNmea2k

◆ eParameterVdr

Member Function Documentation

◆ getJ1939ParameterColumnName()

◆ getJ1939ParameterColumnWidth()

◆ getJ1939ParameterMaxChars()

◆ getJ1939ParameterName()

◆ getJ1939ParameterValueAsString()

◆ getModbusDataTypesForRegisterType()

◆ getModbusParameterColumnWidth()

◆ getModbusParameterMaxChars()

◆ getModbusParameterName()

◆ getModbusParameterValueAsString()

◆ getModbusRegisterTypesForDirection()

◆ getNmea0183ParameterColumnWidth()

◆ getNmea0183ParameterMaxChars()

◆ getNmea0183ParameterName()

◆ getNmea0183ParameterValueAsString()

◆ getNmea2kParameterColumnName()

◆ getNmea2kParameterColumnWidth()

◆ getNmea2kParameterMaxChars()

◆ getNmea2kParameterName()

◆ getNmea2kParameterValueAsString()

◆ getVdrParameterColumnWidth()

◆ getVdrParameterMaxChars()

◆ getVdrParameterName()

◆ getVdrParameterValueAsString()