DEIMOS
Earth Observation Mission CFI Software
EECommon Software User Manual
ESA

EECFI::CfiError Class Reference

Class to manage the CFI exceptions. More...

List of all members.

Public Member Functions

 CfiError ()
 Default constructor.
 CfiError (InternalError const &ie)
 Constructor with an InternalError object as argument.
 CfiError (const CfiError &other)
 ~CfiError () NOEXCEPT
 Destructor.
CfiErroroperator= (const CfiError &other)
long status () const
 Get the status value of CFI function.
void getCodes (std::vector< long > &codes, long &libCode, long &funCode) const
 Method to get the error codes.
std::vector< std::string > & getMsg (std::vector< std::string > &messages) const
 Method to get the error messages.
void addMsg (const std::string &msg)
 Add another message to the error list.

Detailed Description

Class to manage the CFI exceptions.

The exceptions thrown due to errors in the execution of all the CFI functions are caught using this class.


Constructor & Destructor Documentation

EECFI::CfiError::CfiError (  ) 

Default constructor.

EECFI::CfiError::CfiError ( InternalError const &  ie  )  [explicit]

Constructor with an InternalError object as argument.

Parameters:
ie Pointer to InternalError.
EECFI::CfiError::CfiError ( const CfiError other  ) 

Copy constructor.

Parameters:
other The CfiError to copy from
ce CfiError object.
EECFI::CfiError::~CfiError (  ) 

Destructor.


Member Function Documentation

void EECFI::CfiError::addMsg ( const std::string &  msg  ) 

Add another message to the error list.

Parameters:
msg Vector where error messages will be stored.
void EECFI::CfiError::getCodes ( std::vector< long > &  codes,
long &  libCode,
long &  funCode 
) const

Method to get the error codes.

Parameters:
codes Vector where error codes will be stored.
libCode Code of the library where the error was detected (ExpcfiLibrary enum).
funCode Code of the function where the error ocurred, as defined in C-library SUM.
vector< std::string > & EECFI::CfiError::getMsg ( std::vector< std::string > &  messages  )  const

Method to get the error messages.

Parameters:
messages Vector where error messages will be stored.
Returns:
Vector of error messages.
CfiError & EECFI::CfiError::operator= ( const CfiError other  ) 

Copy assigment operator.

Parameters:
other The CfiError to copy/assign from
long EECFI::CfiError::status (  )  const

Get the status value of CFI function.

Returns:
Status value.

Generated on Mon Dec 11 2023 13:28:11 for by doxygen 1.7.1