telux::tel::EtwsInfo Class Reference

Public Member Functions
	EtwsInfo (GeographicalScope geographicalScope, int msgId, int serialNumber, std::string languageCode, std::string messageText, MessagePriority priority, EtwsWarningType warningType, bool emergencyUserAlert, bool activatePopup, bool primary, std::vector< uint8_t > warningSecurityInformation)
GeographicalScope	getGeographicalScope () const
int	getMessageId () const
int	getSerialNumber () const
std::string	getLanguageCode () const
std::string	getMessageBody () const
MessagePriority	getPriority () const
int	getMessageCode () const
int	getUpdateNumber () const
EtwsWarningType	getEtwsWarningType ()
bool	isEmergencyUserAlert ()
bool	isPopupAlert ()
bool	isPrimary ()
std::vector< uint8_t >	getWarningSecurityInformation ()

Detailed Description

Contains information elements for a GSM/UMTS/E-UTRAN/NG-RAN ETWS warning notification. Supported values for each element are defined in 3GPP TS 23.041.

Constructor & Destructor Documentation

telux::tel::EtwsInfo::EtwsInfo	(	GeographicalScope	geographicalScope,
		int	msgId,
		int	serialNumber,
		std::string	languageCode,
		std::string	messageText,
		MessagePriority	priority,
		EtwsWarningType	warningType,
		bool	emergencyUserAlert,
		bool	activatePopup,
		bool	primary,
		std::vector< uint8_t >	warningSecurityInformation
	)

EtwsInfo constructor.

Parameters

[in]	geographicalScope	GeographicalScope
[in]	msgId	Unique message identifier
[in]	serialNumber	Serial number for message
[in]	languageCode	ISO-639-1 language code for message
[in]	messageText	Message text
[in]	priority	MessagePriority
[in]	warningType	EtwsWarningType
[in]	emergencyUserAlert	If true message is emergency user alert otherwise not
[in]	activatePopup	If true message message activate popup flag is set, otherwise popup flag is false.
[in]	primary	If true ETWS message is primary notification otherwise not
[in]	warningSecurityInformation	Buffer containing security information about ETWS primary notification such as timestamp and digital signature

Member Function Documentation

GeographicalScope telux::tel::EtwsInfo::getGeographicalScope

(

)

const

Get the geographicalScope of cellbroadcast message.

Returns

GeographicalScope.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

int telux::tel::EtwsInfo::getMessageId

(

)

const

Get cellbroadcast message identifier. The message identifier identifies the type of the cell broadcast message defined in spec 3GPP TS 23.041 9.4.1.2.2

Returns

Message identifier.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

int telux::tel::EtwsInfo::getSerialNumber

(

)

const

Get the serial number of broadcast (geographical scope + message code + update number for GSM/UMTS).

Returns

int containing cellbroadcast serial number.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

std::string telux::tel::EtwsInfo::getLanguageCode

(

)

const

Get the ISO-639-1 language code for cell broadcast message, or empty string if unspecified. This is not applicable for ETWS primary notification.

Returns

Language code

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

std::string telux::tel::EtwsInfo::getMessageBody

(

)

const

Get the body of cell broadcast message, or empty string if no body available. For ETWS primary notification based on message identifier pre cannned message will be sent.

Returns

body or empty string

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

MessagePriority telux::tel::EtwsInfo::getPriority

(

)

const

Get the priority for the cell broadcast message.

Returns

MessagePriority.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

int telux::tel::EtwsInfo::getMessageCode

(

)

const

Get the cellbroadcast message code.

Returns

int containing cellbroadcast message code.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

int telux::tel::EtwsInfo::getUpdateNumber

(

)

const

Get the cellbroadcast message update number.

Returns

int containing cellbroadcast message's update number.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

EtwsWarningType telux::tel::EtwsInfo::getEtwsWarningType

(

)

Get ETWS warning type.

Returns

EtwsWarningType.

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

bool telux::tel::EtwsInfo::isEmergencyUserAlert

(

)

Returns the ETWS emergency user alert flag.

Returns

true to notify terminal to activate emergency user alert or false otherwise

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

bool telux::tel::EtwsInfo::isPopupAlert

(

)

Returns the ETWS activate popup flag.

Returns

true to notify terminal to activate display popup or false otherwise

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

bool telux::tel::EtwsInfo::isPrimary

(

)

Returns the ETWS format flag. This flag determine whether ETWS message is primary notification or not.

Returns

true if the message is primary message, otherwise secondary message

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.

std::vector<uint8_t> telux::tel::EtwsInfo::getWarningSecurityInformation

(

)

Returns security information about ETWS primary notification such as timestamp and digital signature(applicable only for GSM).

Returns

byte buffer

Note

Eval: This is a new API and is being evaluated. It is subject to change and could break backwards compatibility.