radioMessageAddressUtil.h File Reference

Go to the source code of this file.

Functions
DT_DLL_vrfmodel bool	entityIsMessageSender (const DtVrfObject &entity, const DtVrfObjectMessage &radioMessage)
	This file contains declarations of utility functions used to identify the sender or receiver of a given radio message.
DT_DLL_vrfmodel bool	messageSenderInList (const DtVrfObjectMessage &radioMessage, const std::set< DtString > &objectNameList, const DtVrfObjectManager &objectManager)
	Returns true if message sender is in the list of given object names.
DT_DLL_vrfmodel DtString	messageSenderObjectName (const DtVrfObjectMessage &radioMessage, const DtVrfObjectManager &objectManager)
	Returns object name of message sender.
DT_DLL_vrfmodel DtVrfObject *	messageSenderObject (const DtVrfObjectMessage &radioMessage, const DtVrfObjectManager &objectManager)

Detailed Description

Function Documentation

DT_DLL_vrfmodel bool entityIsMessageSender	(	const DtVrfObject &	entity,
		const DtVrfObjectMessage &	radioMessage
	)

This file contains declarations of utility functions used to identify the sender or receiver of a given radio message.

The transmitter and reciever strings in radio messages may be specified as either object name (recommended) or echelon Id string (obsolete). New code should exclusively use object names to identify transmitter and receiver. Returns true if entity is the message sender (transmitter), false otherwise.

DT_DLL_vrfmodel bool messageSenderInList	(	const DtVrfObjectMessage &	radioMessage,
		const std::set< DtString > &	objectNameList,
		const DtVrfObjectManager &	objectManager
	)

Returns true if message sender is in the list of given object names.

DT_DLL_vrfmodel DtString messageSenderObjectName	(	const DtVrfObjectMessage &	radioMessage,
		const DtVrfObjectManager &	objectManager
	)

Returns object name of message sender.

Returns DtString::nullString() if transmitter is echelon id, and object cannot be located in object manager.

DT_DLL_vrfmodel DtVrfObject* messageSenderObject	(	const DtVrfObjectMessage &	radioMessage,
		const DtVrfObjectManager &	objectManager
	)