---

Message.h

Go to the documentation of this file.

/*************** <auto-copyright.pl BEGIN do not edit this line> **************
 *
 * VR Juggler is (C) Copyright 1998-2003 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.
 *
 * -----------------------------------------------------------------
 * File:          $RCSfile: Message.h,v $
 * Date modified: $Date: 2003/03/06 17:12:00 $
 * Version:       $Revision: 1.4 $
 * -----------------------------------------------------------------
 *
 *************** <auto-copyright.pl END do not edit this line> ***************/

#ifndef _VRJ_TEST_MESSAGE_H_
#define _VRJ_TEST_MESSAGE_H_

#include <vector>
#include <string>
#include <sstream>

namespace vrj {
namespace test
{

/* Message with extra details.
*
* Really just a wrapper around a vector of std::strings
* that describe the type of problem encountered
*/
class Message
{
public:
  Message()
  {;}

  explicit Message( const std::string& shortDesc )
      : mShortDesc(shortDesc)
  {
     mShortDesc = shortDesc;
  }

  Message( const std::string &shortDesc,
           const std::string &detail1 )
      : mShortDesc(shortDesc)
  { addDetail(detail1); }

  Message( const std::string &shortDesc,
           const std::string &detail1,
           const std::string &detail2 )
      : mShortDesc(shortDesc)
  { addDetail(detail1, detail2); }

  Message( const std::string &shortDesc,
           const std::string &detail1,
           const std::string &detail2,
           const std::string &detail3 )
  : mShortDesc(shortDesc)
  { addDetail(detail1, detail2, detail3); }

  std::string shortDesc()
  { return mShortDesc; }

  std::string details() const
  {
     std::stringstream oss;

     for(unsigned i=0;i<mDetails.size();i++)
        oss << "- " << mDetails[i] << "\n";

     return oss.str();
  }

  void clearDetails()
  {  mDetails.clear(); }

  std::vector<std::string> getDetails()
  { return mDetails;}

  void addDetail( const std::string &detail )
  { mDetails.push_back(detail); }

  void addDetail( const std::string& detail1,
                  const std::string& detail2 )
  { addDetail(detail1); addDetail(detail2); }

  void addDetail( const std::string &detail1,
                  const std::string &detail2,
                  const std::string &detail3 )
  { addDetail(detail1); addDetail(detail2); addDetail(detail3); }

  void setShortDesc( const std::string& shortDesc )
  { mShortDesc = shortDesc; }

private:
  std::string              mShortDesc;    
  std::vector<std::string> mDetails;      
};

} }

#endif

---