ReturnStatus.h

Go to the documentation of this file.

/****************** <VPR heading BEGIN do not edit this line> *****************
 *
 * VR Juggler Portable Runtime
 *
 * Original Authors:
 *   Allen Bierbaum, Patrick Hartling, Kevin Meinert, Carolina Cruz-Neira
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile$
 * Date modified: $Date: 2006-10-27 14:56:11 -0500 (Fri, 27 Oct 2006) $
 * Version:       $Revision: 19378 $
 * -----------------------------------------------------------------
 *
 ****************** <VPR heading END do not edit this line> ******************/

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2005 by Iowa State University
 *
 * Original Authors:
 *   Allen Bierbaum, Christopher Just,
 *   Patrick Hartling, Kevin Meinert,
 *   Carolina Cruz-Neira, Albert Baker
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VPR_RETURN_STATUS_H_
#define _VPR_RETURN_STATUS_H_

#include <vpr/vprConfig.h>
#include <iostream>


namespace vpr
{
   class ReturnStatus
   {
   public:
      enum Code
      {
         Succeed,          
         Fail,             
         WouldBlock,       
         Timeout,          
         InProgress,       
         NotConnected,     
         ConnectionAborted 
      };

      ReturnStatus() : mReturnStatus(vpr::ReturnStatus::Succeed)
      {
      }

      void copy(const ReturnStatus& status)
      {
         mReturnStatus = status.mReturnStatus;
      }

      void setCode(const Code& c)
      {
         mReturnStatus = c;
      }

      const Code& code() const
      {
         return mReturnStatus;
      }

      ReturnStatus(const ReturnStatus& status)
      {
         this->copy(status);
      }

      ReturnStatus(const Code& c)
      {
         this->setCode(c);
      }

      ReturnStatus& operator=(const ReturnStatus& status)
      {
         if((&status) != this)
         {
            this->copy( status );
         }
         return *this;
      }

      ReturnStatus& operator=(const Code& c)
      {
         this->setCode(c);
         return *this;
      }

      bool operator==(const ReturnStatus& status) const
      {
         return status.mReturnStatus == mReturnStatus;
      }

      bool operator==(const Code& c) const
      {
         return c == mReturnStatus;
      }

      bool operator!=(const ReturnStatus& status) const
      {
         return status.mReturnStatus != mReturnStatus;
      }

      bool operator!=(const Code& c) const
      {
         return c != mReturnStatus;
      }

   public:
      bool success() const
      {
         return mReturnStatus == vpr::ReturnStatus::Succeed;
      }

      bool failure() const
      {
         return mReturnStatus == vpr::ReturnStatus::Fail;
      }

      bool wouldBlock() const
      {
         return mReturnStatus == vpr::ReturnStatus::WouldBlock;
      }

      bool inProgress() const
      {
         return mReturnStatus == vpr::ReturnStatus::InProgress;
      }

      bool timeout() const
      {
         return mReturnStatus == vpr::ReturnStatus::Timeout;
      }

      bool connectionAborted() const
      {
         return mReturnStatus == vpr::ReturnStatus::ConnectionAborted;
      }

   private:
      ReturnStatus::Code mReturnStatus;
   };
} // namespace vpr

inline std::ostream& operator<<(std::ostream& out, const vpr::ReturnStatus& ret)
{
   switch(ret.code())
   {
   case vpr::ReturnStatus::Succeed:
      out << "Succeed";
      break;
   case vpr::ReturnStatus::Fail:             
      out << "Fail";
      break;
   case vpr::ReturnStatus::WouldBlock:       
      out << "WouldBlock";
      break;
   case vpr::ReturnStatus::Timeout:          
      out << "Timeout";
      break;
   case vpr::ReturnStatus::InProgress:       
      out << "InProgress";
      break;
   case vpr::ReturnStatus::NotConnected:
      out << "NotConnected";
      break;
   default:
      out << "Unknown";
      break;
   }

   return out;
}

#endif

---