ITS
AppDenmResultData Class Reference

#include <AppDenmResultData.h>

Collaboration diagram for AppDenmResultData:
[legend]

Public Types

enum  AppDenmResultData_enum { AppDenmResultData_failureNotification }
 The e_AppDenmResultData enum defines the options bit position. More...
 
enum  failureNotification_enum {
  success, cannotCreateDENM_unableToCollectRequiredData, cannotCreateDENM_unableToEncodeDENM, eventIsInThePast,
  eventDoesNotExist, cannotSendDENM, eventNotActive
}
 The e_failureNotification enum defines the success or failure code. More...
 
typedef enum AppDenmResultData::AppDenmResultData_enum e_AppDenmResultData
 The e_AppDenmResultData enum defines the options bit position. More...
 
typedef enum AppDenmResultData::failureNotification_enum e_failureNotification
 The e_failureNotification enum defines the success or failure code. More...
 

Public Member Functions

 AppDenmResultData ()
 AppDenmResultData AppDenmResultData constructor. More...
 
 AppDenmResultData (ActionID_t actionID, bool success, e_failureNotification failureNotification, DENM_t *denm, ParameterDENM *paramDENM)
 AppDenmResultData AppDenmResultData initialization constructor. More...
 
 AppDenmResultData (QByteArray datagram)
 AppDenmResultData AppDenmResultData initlization constructor. More...
 
QByteArray toBin ()
 toBin Encode the AppDenmResultData into a byte array. More...
 
quint8 getOptions ()
 getOptions Generate the option byte. More...
 
ActionID_t actionID () const
 actionID ActionID getter. More...
 
e_failureNotificationfailureNotification () const
 failureNotification Failure notitfication getter. More...
 
void setActionID (ActionID_t a)
 setActionID ActionID setter. More...
 
void setFailureNotification (e_failureNotification *f)
 setFailureNotification Failure notification setter. More...
 

Private Attributes

ActionID_t m_actionID
 
e_failureNotificationm_failureNotification
 
ParameterDENMm_paramDENM
 
QByteArray m_denm
 

Detailed Description

Definition at line 20 of file AppDenmResultData.h.

Member Typedef Documentation

◆ e_AppDenmResultData

The e_AppDenmResultData enum defines the options bit position.

◆ e_failureNotification

The e_failureNotification enum defines the success or failure code.

Member Enumeration Documentation

◆ AppDenmResultData_enum

The e_AppDenmResultData enum defines the options bit position.

Enumerator
AppDenmResultData_failureNotification 

The execution failed.

Definition at line 26 of file AppDenmResultData.h.

◆ failureNotification_enum

The e_failureNotification enum defines the success or failure code.

Enumerator
success 

Success.

cannotCreateDENM_unableToCollectRequiredData 

Can't create DENM, because we're unable to collect required data.

cannotCreateDENM_unableToEncodeDENM 

Can't create DENM, because we're unable to encode it.

eventIsInThePast 

The event is in the past.

eventDoesNotExist 

The event to update / terminate does not exist.

cannotSendDENM 

The DENM can't be sent.

eventNotActive 

The event to update / terminate is not active.

Definition at line 34 of file AppDenmResultData.h.

Constructor & Destructor Documentation

◆ AppDenmResultData() [1/3]

AppDenmResultData::AppDenmResultData ( )

AppDenmResultData AppDenmResultData constructor.

Definition at line 5 of file AppDenmResultData.cpp.

References m_failureNotification.

◆ AppDenmResultData() [2/3]

AppDenmResultData::AppDenmResultData ( ActionID_t  actionID,
bool  success,
e_failureNotification  failureNotification,
DENM_t denm,
ParameterDENM paramDENM 
)

AppDenmResultData AppDenmResultData initialization constructor.

Parameters
actionIDThe DENM ActionID.
successIs the result a success?
failureNotificationThe success or failure code.
denmThe DENM.
paramDENMThe DENM configuration.

Definition at line 10 of file AppDenmResultData.cpp.

References actionID(), asn_DEF_DENM, asn_enc_rval_s::encoded, failureNotification(), m_actionID, m_denm, m_failureNotification, m_paramDENM, MSG_LENGTH, success, and uper_encode_to_buffer().

Here is the call graph for this function:

◆ AppDenmResultData() [3/3]

AppDenmResultData::AppDenmResultData ( QByteArray  datagram)

AppDenmResultData AppDenmResultData initlization constructor.

Parameters
datagramThe byte array encoded AppDenmResultData.

Definition at line 38 of file AppDenmResultData.cpp.

References AppDenmResultData_failureNotification, extractUInt(), m_actionID, m_denm, m_failureNotification, ActionID::originatingStationID, and ActionID::sequenceNumber.

Here is the call graph for this function:

Member Function Documentation

◆ actionID()

ActionID_t AppDenmResultData::actionID ( ) const
inline

actionID ActionID getter.

Returns
The ActionID.

Definition at line 80 of file AppDenmResultData.h.

References m_actionID.

Referenced by AppDenmResultData(), App2Fac::sendMessageToDENBasicService(), UpperTester::utDenmTerminate(), UpperTester::utDenmTrigger(), and UpperTester::utDenmUpdate().

Here is the caller graph for this function:

◆ failureNotification()

e_failureNotification* AppDenmResultData::failureNotification ( ) const
inline

failureNotification Failure notitfication getter.

Returns
The failure notification.

Definition at line 85 of file AppDenmResultData.h.

References m_failureNotification.

Referenced by AppDenmResultData(), App2Fac::sendMessageToDENBasicService(), UpperTester::utDenmTerminate(), UpperTester::utDenmTrigger(), and UpperTester::utDenmUpdate().

Here is the caller graph for this function:

◆ getOptions()

quint8 AppDenmResultData::getOptions ( )

getOptions Generate the option byte.

Returns
The option byte.

Definition at line 61 of file AppDenmResultData.cpp.

References AppDenmResultData_failureNotification, and m_failureNotification.

Referenced by toBin().

Here is the caller graph for this function:

◆ setActionID()

void AppDenmResultData::setActionID ( ActionID_t  a)
inline

setActionID ActionID setter.

Parameters
aThe new ActionID.

Definition at line 92 of file AppDenmResultData.h.

References m_actionID.

◆ setFailureNotification()

void AppDenmResultData::setFailureNotification ( e_failureNotification f)
inline

setFailureNotification Failure notification setter.

Parameters
fThe new failure notification.

Definition at line 97 of file AppDenmResultData.h.

References f(), and m_failureNotification.

Here is the call graph for this function:

◆ toBin()

QByteArray AppDenmResultData::toBin ( )

toBin Encode the AppDenmResultData into a byte array.

Returns
The encoded in byte array AppDenmResultData.

Definition at line 71 of file AppDenmResultData.cpp.

References getOptions(), m_actionID, m_denm, m_failureNotification, m_paramDENM, ParameterDENM::mtAppDENMResult(), ActionID::originatingStationID, and ActionID::sequenceNumber.

Referenced by denTriggeringManagement::AppDENM_result(), and denReceptionManagement::AppDENM_result().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_actionID

ActionID_t AppDenmResultData::m_actionID
private

The ActionID.

Definition at line 100 of file AppDenmResultData.h.

Referenced by actionID(), AppDenmResultData(), setActionID(), and toBin().

◆ m_denm

QByteArray AppDenmResultData::m_denm
private

The UPER encoded DENM.

Definition at line 103 of file AppDenmResultData.h.

Referenced by AppDenmResultData(), and toBin().

◆ m_failureNotification

e_failureNotification* AppDenmResultData::m_failureNotification
private

The success of failure code.

Definition at line 101 of file AppDenmResultData.h.

Referenced by AppDenmResultData(), failureNotification(), getOptions(), setFailureNotification(), and toBin().

◆ m_paramDENM

ParameterDENM* AppDenmResultData::m_paramDENM
private

The DENM configuration.

Definition at line 102 of file AppDenmResultData.h.

Referenced by AppDenmResultData(), and toBin().


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