ldas-tools-framecpp  2.9.3
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
FrameCPP::Common::VerifyException Class Reference

#include <Verify.hh>

Inheritance diagram for FrameCPP::Common::VerifyException:
Inheritance graph
[legend]
Collaboration diagram for FrameCPP::Common::VerifyException:
Collaboration graph
[legend]

Public Types

enum  error_type {
  NO_ERROR = 0 , CHECKSUM_ERROR , FILE_OPEN_ERROR , UNSUPPORTED_FRAME_SPEC ,
  FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE , NO_CHECKSUM , INVALID_FRAME_STRUCTURE ,
  FILE_TRUNCATION , DATA_INVALID , METADATA_INVALID , DUPLICATE_CHANNEL_NAME ,
  MAX_ERROR = DUPLICATE_CHANNEL_NAME , NO_ERROR = 0 , CHECKSUM_ERROR , FILE_OPEN_ERROR ,
  UNSUPPORTED_FRAME_SPEC , FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE , NO_CHECKSUM ,
  INVALID_FRAME_STRUCTURE , FILE_TRUNCATION , DATA_INVALID , METADATA_INVALID ,
  DUPLICATE_CHANNEL_NAME , MAX_ERROR = DUPLICATE_CHANNEL_NAME , NO_ERROR = 0 , CHECKSUM_ERROR ,
  FILE_OPEN_ERROR , UNSUPPORTED_FRAME_SPEC , FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE ,
  NO_CHECKSUM , INVALID_FRAME_STRUCTURE , FILE_TRUNCATION , DATA_INVALID ,
  METADATA_INVALID , DUPLICATE_CHANNEL_NAME , MAX_ERROR = DUPLICATE_CHANNEL_NAME
}
 
enum  error_type {
  NO_ERROR = 0 , CHECKSUM_ERROR , FILE_OPEN_ERROR , UNSUPPORTED_FRAME_SPEC ,
  FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE , NO_CHECKSUM , INVALID_FRAME_STRUCTURE ,
  FILE_TRUNCATION , DATA_INVALID , METADATA_INVALID , DUPLICATE_CHANNEL_NAME ,
  MAX_ERROR = DUPLICATE_CHANNEL_NAME , NO_ERROR = 0 , CHECKSUM_ERROR , FILE_OPEN_ERROR ,
  UNSUPPORTED_FRAME_SPEC , FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE , NO_CHECKSUM ,
  INVALID_FRAME_STRUCTURE , FILE_TRUNCATION , DATA_INVALID , METADATA_INVALID ,
  DUPLICATE_CHANNEL_NAME , MAX_ERROR = DUPLICATE_CHANNEL_NAME , NO_ERROR = 0 , CHECKSUM_ERROR ,
  FILE_OPEN_ERROR , UNSUPPORTED_FRAME_SPEC , FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE ,
  NO_CHECKSUM , INVALID_FRAME_STRUCTURE , FILE_TRUNCATION , DATA_INVALID ,
  METADATA_INVALID , DUPLICATE_CHANNEL_NAME , MAX_ERROR = DUPLICATE_CHANNEL_NAME
}
 
enum  error_type {
  NO_ERROR = 0 , CHECKSUM_ERROR , FILE_OPEN_ERROR , UNSUPPORTED_FRAME_SPEC ,
  FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE , NO_CHECKSUM , INVALID_FRAME_STRUCTURE ,
  FILE_TRUNCATION , DATA_INVALID , METADATA_INVALID , DUPLICATE_CHANNEL_NAME ,
  MAX_ERROR = DUPLICATE_CHANNEL_NAME , NO_ERROR = 0 , CHECKSUM_ERROR , FILE_OPEN_ERROR ,
  UNSUPPORTED_FRAME_SPEC , FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE , NO_CHECKSUM ,
  INVALID_FRAME_STRUCTURE , FILE_TRUNCATION , DATA_INVALID , METADATA_INVALID ,
  DUPLICATE_CHANNEL_NAME , MAX_ERROR = DUPLICATE_CHANNEL_NAME , NO_ERROR = 0 , CHECKSUM_ERROR ,
  FILE_OPEN_ERROR , UNSUPPORTED_FRAME_SPEC , FRAME_SPEC_CONFORMANCE , UNSUPPORTED_CHECKSUM_TYPE ,
  NO_CHECKSUM , INVALID_FRAME_STRUCTURE , FILE_TRUNCATION , DATA_INVALID ,
  METADATA_INVALID , DUPLICATE_CHANNEL_NAME , MAX_ERROR = DUPLICATE_CHANNEL_NAME
}
 

Public Member Functions

 VerifyException (error_type ErrorCode, const std::string &What="")
 
error_type ErrorCode () const
 
virtual VerifyExceptionClone () const
 
 VerifyException (error_type ErrorCode, const std::string &What="")
 
error_type ErrorCode () const
 
virtual VerifyExceptionClone () const
 
 VerifyException (error_type ErrorCode, const std::string &What="")
 
error_type ErrorCode () const
 
virtual VerifyExceptionClone () const
 

Static Public Member Functions

static std::string StrError (error_type ErrorNum)
 Return string describing error code. More...
 
static std::string StrErrorType (const error_type Error)
 Retrieve the string representation of the error_type. More...
 
static std::string StrError (error_type ErrorNum)
 Return string describing error code. More...
 
static std::string StrErrorType (const error_type Error)
 Retrieve the string representation of the error_type. More...
 
static std::string StrError (error_type ErrorNum)
 Return string describing error code. More...
 
static std::string StrErrorType (const error_type Error)
 Retrieve the string representation of the error_type. More...
 

Protected Member Functions

VerifyExceptionoperator= (const VerifyException &Error)
 
void extendError (const std::string &Message)
 
VerifyExceptionoperator= (const VerifyException &Error)
 
void extendError (const std::string &Message)
 
VerifyExceptionoperator= (const VerifyException &Error)
 
void extendError (const std::string &Message)
 

Private Member Functions

std::string build_error_string (error_type ErrorCode, const std::string &Message)
 
std::string build_error_string (error_type ErrorCode, const std::string &Message)
 
std::string build_error_string (error_type ErrorCode, const std::string &Message)
 

Private Attributes

const error_type m_error_code
 

Static Private Attributes

static const char * m_error_strings []
 
static const char * m_error_type_strings []
 

Friends

class Verify
 

Member Enumeration Documentation

◆ error_type [1/3]

Enumerator
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 

◆ error_type [2/3]

Enumerator
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 

◆ error_type [3/3]

Enumerator
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 
NO_ERROR 
CHECKSUM_ERROR 
FILE_OPEN_ERROR 
UNSUPPORTED_FRAME_SPEC 
FRAME_SPEC_CONFORMANCE 
UNSUPPORTED_CHECKSUM_TYPE 
NO_CHECKSUM 
INVALID_FRAME_STRUCTURE 
FILE_TRUNCATION 
DATA_INVALID 
METADATA_INVALID 
DUPLICATE_CHANNEL_NAME 
MAX_ERROR 

Constructor & Destructor Documentation

◆ VerifyException() [1/3]

FrameCPP::Common::VerifyException::VerifyException ( error_type  ErrorCode,
const std::string &  What = "" 
)
inline

◆ VerifyException() [2/3]

FrameCPP::Common::VerifyException::VerifyException ( error_type  ErrorCode,
const std::string &  What = "" 
)

◆ VerifyException() [3/3]

FrameCPP::Common::VerifyException::VerifyException ( error_type  ErrorCode,
const std::string &  What = "" 
)

Member Function Documentation

◆ build_error_string() [1/3]

std::string FrameCPP::Common::VerifyException::build_error_string ( error_type  ErrorCode,
const std::string &  Message 
)
inlineprivate

◆ build_error_string() [2/3]

std::string FrameCPP::Common::VerifyException::build_error_string ( error_type  ErrorCode,
const std::string &  Message 
)
private

◆ build_error_string() [3/3]

std::string FrameCPP::Common::VerifyException::build_error_string ( error_type  ErrorCode,
const std::string &  Message 
)
private

◆ Clone() [1/3]

VerifyException * VerifyException::Clone ( ) const
virtual

◆ Clone() [2/3]

virtual VerifyException* FrameCPP::Common::VerifyException::Clone ( ) const
virtual

◆ Clone() [3/3]

virtual VerifyException* FrameCPP::Common::VerifyException::Clone ( ) const
virtual

◆ ErrorCode() [1/3]

VerifyException::error_type FrameCPP::Common::VerifyException::ErrorCode ( ) const
inline

◆ ErrorCode() [2/3]

error_type FrameCPP::Common::VerifyException::ErrorCode ( ) const

◆ ErrorCode() [3/3]

error_type FrameCPP::Common::VerifyException::ErrorCode ( ) const

◆ extendError() [1/3]

void VerifyException::extendError ( const std::string &  Message)
protected

◆ extendError() [2/3]

void FrameCPP::Common::VerifyException::extendError ( const std::string &  Message)
protected

◆ extendError() [3/3]

void FrameCPP::Common::VerifyException::extendError ( const std::string &  Message)
protected

◆ operator=() [1/3]

VerifyException & VerifyException::operator= ( const VerifyException Error)
protected

◆ operator=() [2/3]

VerifyException& FrameCPP::Common::VerifyException::operator= ( const VerifyException Error)
protected

◆ operator=() [3/3]

VerifyException& FrameCPP::Common::VerifyException::operator= ( const VerifyException Error)
protected

◆ StrError() [1/3]

std::string VerifyException::StrError ( Verify::error_type  ErrNum)
static

Return string describing error code.

Parameters
[in]ErrorNumError code
Returns
String describing error code

◆ StrError() [2/3]

static std::string FrameCPP::Common::VerifyException::StrError ( error_type  ErrorNum)
static

Return string describing error code.

Parameters
[in]ErrorNumError code
Returns
String describing error code

◆ StrError() [3/3]

static std::string FrameCPP::Common::VerifyException::StrError ( error_type  ErrorNum)
static

Return string describing error code.

Parameters
[in]ErrorNumError code
Returns
String describing error code

◆ StrErrorType() [1/3]

std::string VerifyException::StrErrorType ( const error_type  Error)
static

Retrieve the string representation of the error_type.

Parameters
[in]ErrorNumError code
Returns
String describing error code

◆ StrErrorType() [2/3]

static std::string FrameCPP::Common::VerifyException::StrErrorType ( const error_type  Error)
static

Retrieve the string representation of the error_type.

Parameters
[in]ErrorNumError code
Returns
String describing error code

◆ StrErrorType() [3/3]

static std::string FrameCPP::Common::VerifyException::StrErrorType ( const error_type  Error)
static

Retrieve the string representation of the error_type.

Parameters
[in]ErrorNumError code
Returns
String describing error code

Friends And Related Function Documentation

◆ Verify

Verify
friend

Member Data Documentation

◆ m_error_code

const error_type FrameCPP::Common::VerifyException::m_error_code
private

◆ m_error_strings

static const char * FrameCPP::Common::VerifyException::m_error_strings
staticprivate
Initial value:
= {
"no failure",
"checksum error",
"unreadable file error",
"unsupported frame version error",
"frame does not conform to the frame specification",
"the type of checksum being requested was unknown.",
"no checksum was supplied at the end of the file",
"one of the internal frame structures does not pass its own consitancy "
"check",
"the file is missing the FrEndOfFile structure required by the frame "
"specification.",
"One or more channels has a non-zero dataValid field.",
"One or more pieces of the filename meta data is invalid.",
"One or more channel names have been duplicated within a frame."
}

◆ m_error_type_strings

static const char * FrameCPP::Common::VerifyException::m_error_type_strings
staticprivate
Initial value:
= {
"NO_ERROR",
"CHECKSUM_ERROR",
"FILE_OPEN_ERROR",
"UNSUPPORTED_FRAME_SPEC",
"FRAME_SPEC_CONFORMANCE",
"UNSUPPORTED_CHECKSUM_TYPE",
"NO_CHECKSUM",
"INVALID_FRAME_STRUCTURE",
"FILE_TRUNCATION",
"DATA_INVALID",
"METADATA_INVALID",
"DUPLICATE_CHANNEL_NAME",
}

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