telux::tel::CmasInfo Class Reference

Public Member Functions
	CmasInfo (GeographicalScope geographicalScope, int msgId, int serialNumber, std::string languageCode, std::string messageText, MessagePriority priority, CmasMessageClass messageClass, CmasSeverity severity, CmasUrgency urgency, CmasCertainty certainty, std::shared_ptr< WarningAreaInfo > warningAreaInfo)
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
CmasMessageClass	getMessageClass ()
CmasSeverity	getSeverity ()
CmasUrgency	getUrgency ()
CmasCertainty	getCertainty ()
std::shared_ptr< WarningAreaInfo >	getWarningAreaInfo ()

Detailed Description

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

Constructor & Destructor Documentation

telux::tel::CmasInfo::CmasInfo	(	GeographicalScope	geographicalScope,
		int	msgId,
		int	serialNumber,
		std::string	languageCode,
		std::string	messageText,
		MessagePriority	priority,
		CmasMessageClass	messageClass,
		CmasSeverity	severity,
		CmasUrgency	urgency,
		CmasCertainty	certainty,
		std::shared_ptr< WarningAreaInfo >	warningAreaInfo
	)

CmasInfo 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]	messageClass	CmasMessageClass
[in]	severity	CmasSeverity
[in]	urgency	CmasUrgency
[in]	certainty	CmasCertainty

Member Function Documentation

GeographicalScope telux::tel::CmasInfo::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::CmasInfo::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::CmasInfo::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::CmasInfo::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::CmasInfo::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::CmasInfo::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::CmasInfo::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::CmasInfo::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.

CmasMessageClass telux::tel::CmasInfo::getMessageClass

(

)

Get CMAS message class.

Returns

CmasMessageClass.

Note

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

CmasSeverity telux::tel::CmasInfo::getSeverity

(

)

Get CMAS message severity.

Returns

CmasSeverity.

Note

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

CmasUrgency telux::tel::CmasInfo::getUrgency

(

)

Get CMAS message urgency.

Returns

CmasUrgency.

Note

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

CmasCertainty telux::tel::CmasInfo::getCertainty

(

)

Get CMAS message certainty.

Returns

CmasCertainty.

Note

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

std::shared_ptr<WarningAreaInfo> telux::tel::CmasInfo::getWarningAreaInfo

(

)

Returns warning area information for alert. This is applicable for LTE and NR5G

Returns

pointer to WarningAreaInfo or null if there is no warning area information available.

Note

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