RDMReply.h

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * RDMReply.h
 * The RDMReply object.
 * Copyright (C) 2015 Simon Newton
 */

#ifndef INCLUDE_OLA_RDM_RDMREPLY_H_
#define INCLUDE_OLA_RDM_RDMREPLY_H_

#include <ola/base/Macro.h>
#include <ola/rdm/RDMCommand.h>
#include <ola/rdm/RDMFrame.h>
#include <ola/rdm/RDMResponseCodes.h>

#include <string>
#include <memory>

namespace ola {
namespace rdm {

struct RDMReply {
 public:
  explicit RDMReply(RDMStatusCode status_code);

  RDMReply(RDMStatusCode status_code, RDMResponse *response);

  RDMReply(RDMStatusCode status_code,
           RDMResponse *response,
           const RDMFrames &frames);

  RDMStatusCode StatusCode() const { return m_status_code; }

  const RDMResponse* Response() const { return m_response.get(); }

  RDMResponse* MutableResponse() { return m_response.get(); }

  const RDMFrames& Frames() const { return m_frames; }

  bool operator==(const RDMReply &other) const;

  std::string ToString() const;

  friend std::ostream& operator<<(std::ostream &out,
                                  const RDMReply &reply) {
    return out << reply.ToString();
  }

  static RDMReply* FromFrame(const RDMFrame &frame,
                             const RDMRequest *request = NULL);

  static RDMReply* DUBReply(const RDMFrame &frame);

 private:
  RDMStatusCode m_status_code;
  std::auto_ptr<RDMResponse> m_response;
  RDMFrames m_frames;

  DISALLOW_COPY_AND_ASSIGN(RDMReply);
};
}  // namespace rdm
}  // namespace ola
#endif  // INCLUDE_OLA_RDM_RDMREPLY_H_