SamStatus Class Reference

This class is used to track the status results of some methods in the BAM classes. More...

#include <SamStatus.h>

Collaboration diagram for SamStatus:

[legend]

List of all members.

Public Types
enum	Status {   SUCCESS = 0, UNKNOWN, NO_MORE_RECS, FAIL_IO,   FAIL_ORDER, FAIL_PARSE, INVALID_SORT, INVALID,   FAIL_MEM }
	Return value enum for the SamFile class methods. More...
Public Member Functions
	SamStatus (ErrorHandler::HandlingType handleType=ErrorHandler::EXCEPTION)
	Constructor that takes in the handling type, defaulting it to exception.
	~SamStatus ()
	Destructor.
void	reset ()
	Reset this status to a default state.
void	setHandlingType (ErrorHandler::HandlingType handleType)
	Set how to handle the errors when they are set.
void	setStatus (Status newStatus, const char *newMessage)
	Set the status with the specified status enum and message.
void	addError (Status newStatus, const char *newMessage)
	Add the specified error message to the status message, setting the status to newStatus if the current status is SUCCESS.
void	addError (SamStatus newStatus)
	Add the specified status to the status message, setting the status to newStatus if the current status is SUCCESS.
Status	getStatus () const
	Return the enum for this status object.
const char *	getStatusMessage () const
	Return the status message for this object.
SamStatus &	operator= (Status newStatus)
	Overload operator = to set the sam status type to the passed in status and to clear the message string.
bool	operator!= (const SamStatus::Status &compStatus) const
	Overload operator != to determine if the passed in type is not equal to this status's type.
bool	operator== (const SamStatus::Status &compStatus) const
	Overload operator == to determine if the passed in type is equal to this status's type.
Static Public Member Functions
static const char *	getStatusString (SamStatus::Status statusEnum)
	Return a string representation of the passed in status enum.
static bool	isContinuableStatus (SamStatus::Status status)
	Returns whether or not it is "safe" to keep processing the file after the specified status return.

---

Detailed Description

This class is used to track the status results of some methods in the BAM classes.

It contains a status enum that describing the status.

Definition at line 26 of file SamStatus.h.

---

Member Enumeration Documentation

enum SamStatus::Status

Return value enum for the SamFile class methods.

Enumerator:

SUCCESS	method completed successfully.
UNKNOWN	unknown result (default value should never be used)
NO_MORE_RECS	NO_MORE_RECS: failed to read a record since there are no more to read either in the file or section if section based reading.
FAIL_IO	method failed due to an I/O issue.
FAIL_ORDER	FAIL_ORDER: method failed because it was called out of order, like trying to read a file without opening it for read or trying to read a record before the header.
FAIL_PARSE	failed to parse a record/header - invalid format.
INVALID_SORT	record is invalid due to it not being sorted.
INVALID	record is invalid other than for sorting.
FAIL_MEM	fail a memory allocation.

Definition at line 31 of file SamStatus.h.

        { SUCCESS = 0, ///< method completed successfully.
          UNKNOWN, ///< unknown result (default value should never be used)
          /// NO_MORE_RECS: failed to read a record since there are no more to
          /// read either in the file or section if section based reading.
          NO_MORE_RECS,
          FAIL_IO, ///< method failed due to an I/O issue.
          /// FAIL_ORDER: method failed because it was called out of order,
          /// like trying to read a file without opening it for read or trying
          /// to read a record before the header.
          FAIL_ORDER,
          FAIL_PARSE, ///< failed to parse a record/header - invalid format.
          INVALID_SORT, ///< record is invalid due to it not being sorted.
          INVALID, ///< record is invalid other than for sorting.
          FAIL_MEM ///< fail a memory allocation.
        };

---

Member Function Documentation

void SamStatus::addError

(

SamStatus

newStatus

)

Add the specified status to the status message, setting the status to newStatus if the current status is SUCCESS.

Definition at line 122 of file SamStatus.cpp.

References SUCCESS.

{
    if(myType == SamStatus::SUCCESS)
    {
        myType = newStatus.myType;
    }
    else
    {
        myMessage += "\n";
    }
    myMessage += newStatus.myMessage;

    if(newStatus != SUCCESS)
    {
        handleError(newStatus.myType, newStatus.myMessage.c_str());
    }
}

void SamStatus::addError	(	Status	newStatus,
		const char *	newMessage
	)

Add the specified error message to the status message, setting the status to newStatus if the current status is SUCCESS.

Definition at line 99 of file SamStatus.cpp.

References getStatusString(), and SUCCESS.

{
    if(myType == SamStatus::SUCCESS)
    {
        myType = newStatus;
    }
    else
    {
        myMessage += "\n";
    }
    myMessage += getStatusString(newStatus);
    myMessage += ": ";
    myMessage += newMessage;

    if(newStatus != SUCCESS)
    {
        handleError(newStatus, newMessage);
    }
}

bool SamStatus::isContinuableStatus

(

SamStatus::Status

status

)

[static]

Returns whether or not it is "safe" to keep processing the file after the specified status return.

Definition at line 41 of file SamStatus.cpp.

References FAIL_PARSE, INVALID, INVALID_SORT, and SUCCESS.

{
    if(status == SamStatus::SUCCESS || status == SamStatus::FAIL_PARSE || 
       status == SamStatus::INVALID_SORT || status == SamStatus::INVALID)
    {
        // The status is such that file processing can continue.
        return(true);
    }
    // UNKNOWN, NO_MORE_RECS, FAIL_IO, FAIL_ORDER, FAIL_MEM
    return(false);
}

bool SamStatus::operator!=

(

const SamStatus::Status &

compStatus

)

const

Overload operator != to determine if the passed in type is not equal to this status's type.

Definition at line 172 of file SamStatus.cpp.

{
    return(compStatus != myType);
}

SamStatus & SamStatus::operator=

(

SamStatus::Status

newStatus

)

Overload operator = to set the sam status type to the passed in status and to clear the message string.

Definition at line 157 of file SamStatus.cpp.

References reset(), and SUCCESS.

{
    reset();
    myType = newStatus;

    if(newStatus != SUCCESS)
    {
        handleError(newStatus, "");
    }
    return(*this);
}

bool SamStatus::operator==

(

const SamStatus::Status &

compStatus

)

const

Overload operator == to determine if the passed in type is equal to this status's type.

Definition at line 180 of file SamStatus.cpp.

{
    return(compStatus == myType);
}

---

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

• bam/SamStatus.h
• bam/SamStatus.cpp