DUNE: Uniform Navigational Environment  2019.02.1
Transports::IridiumSBD::SessionResult Class Reference

Detailed Description

This class interprets and represents the result of an SBD Session.

Public Member Functions

 SessionResult (void)
 
void parse (const std::string &str)
 
bool isSuccessMO (void) const
 
bool isSuccessMT (void) const
 
unsigned getStatusMO (void) const
 
unsigned getStatusMT (void) const
 
unsigned getSequenceMO (void) const
 
unsigned getSequenceMT (void) const
 
unsigned getLengthMT (void) const
 
unsigned getQueuedMT (void) const
 

Constructor & Destructor Documentation

Transports::IridiumSBD::SessionResult::SessionResult ( void  )
inline

Constructor.

Member Function Documentation

unsigned Transports::IridiumSBD::SessionResult::getLengthMT ( void  ) const
inline

Retrieve the length in bytes of the MT SBD message received from the GSS or zero if no message was received.

Returns
length of the MT SBD message.
unsigned Transports::IridiumSBD::SessionResult::getQueuedMT ( void  ) const
inline

Retrieve the count of MT SBD messages waiting at the GSS to be transferred to the transceiver.

Returns
count of MT SBD messages.

Referenced by Transports::IridiumSBD::Driver::getQueuedMT().

unsigned Transports::IridiumSBD::SessionResult::getSequenceMO ( void  ) const
inline

Retrieve the MO SBD message sequence number.

Returns
MO SBD message sequence number.

Referenced by Transports::IridiumSBD::Task::handleSessionResult().

unsigned Transports::IridiumSBD::SessionResult::getSequenceMT ( void  ) const
inline

Retrieve the MT SBD message sequence number.

Returns
MT SBD message sequence number.
unsigned Transports::IridiumSBD::SessionResult::getStatusMO ( void  ) const
inline

Retrieve the MO status code.

Returns
MO status code.

Referenced by Transports::IridiumSBD::Task::handleSessionResult().

unsigned Transports::IridiumSBD::SessionResult::getStatusMT ( void  ) const
inline

Retrieve the MT status code.

Returns
MT status code.

Referenced by Transports::IridiumSBD::Task::handleSessionResult().

bool Transports::IridiumSBD::SessionResult::isSuccessMO ( void  ) const
inline

Test if the MO status denotes that the MO SBD message, if any, was transferred successfully.

Returns
true if the MO transaction was successful, false otherwise.

Referenced by Transports::IridiumSBD::Task::handleSessionResult().

bool Transports::IridiumSBD::SessionResult::isSuccessMT ( void  ) const
inline

Test if the MT status denotes that a mailbox check was performed or an MT SBD message was received.

Returns
true if the MT transaction was successful, false otherwise.

Referenced by Transports::IridiumSBD::Driver::getQueuedMT().

void Transports::IridiumSBD::SessionResult::parse ( const std::string &  str)
inline

Parse the response of the +SBDIX command.

Parameters
[in]str+SBDIX response.
Exceptions
InvalidFormatif response has invalid format.

Referenced by Transports::IridiumSBD::Driver::getQueuedMT().

Collaboration diagram for Transports::IridiumSBD::SessionResult:
Collaboration graph