Request.h

/***********************************************************************
 * The rDock program was developed from 1998 - 2006 by the software team
 * at RiboTargets (subsequently Vernalis (R&D) Ltd).
 * In 2006, the software was licensed to the University of York for
 * maintenance and distribution.
 * In 2012, Vernalis and the University of York agreed to release the
 * program as Open Source software.
 * This version is licensed under GNU-LGPL version 3.0 with support from
 * the University of Barcelona.
 * http://rdock.sourceforge.net/
 ***********************************************************************/
 
// Simple struct to represent a request message
// Stores a request ID (int) and an arbitrary length list of variant params
// Base class cannot be instantiated.
// Derived class constructors should set the ID and the param list accordingly
 
#ifndef _RBTREQUEST_H_
#define _RBTREQUEST_H_
 
#include "rxdock/Variant.h"
 
#include <nlohmann/json.hpp>
 
using json = nlohmann::json;
 
namespace rxdock {
 
typedef int RequestID;
 
// Only check request assertions in debug build
#ifdef _NDEBUG
const Bool REQ_CHECK = false;
#else
const bool REQ_CHECK = true;
#endif //_NDEBUG
 
class Request {
public:
  // Constructors/destructors
  virtual ~Request() {}
 
  Request(json j) {
    j.get_to(*this);
    _RBTOBJECTCOUNTER_CONSTR_("Request");
  }
 
  friend void to_json(json &j, const Request &request) {
    /*json variantList;
    for (const auto &aIter : request.m_parameters) {
      json request = *aIter;
      variantList.push_back(request);
    }*/
    j = json{{"request-id", request.m_id},
             {"variant-list", request.m_parameters}};
  }
 
  friend void from_json(const json &j, Request &request) {
    j.at("request-id").get_to(request.m_id);
    j.at("variant-list").get_to(request.m_parameters);
  }
 
  // Public methods
  RequestID GetID() const { return m_id; }
  unsigned int GetNumParameters() const { return m_parameters.size(); }
  VariantList GetParameters() const { return m_parameters; }
 
  // Protected methods
  // Protected constructor to be used by derived classes to set request ID
  Request(RequestID id) : m_id(id) {}
  // AddParameter can be used by derived classes to add parameters to list
  void AddParameter(const Variant &v) { m_parameters.push_back(v); }
 
private:
  // Private data
  RequestID m_id;
  VariantList m_parameters;
};
 
// Useful typedefs
typedef SmartPtr<Request> RequestPtr;
typedef std::vector<RequestPtr> RequestList;
typedef RequestList::iterator RequestListIter;
typedef RequestList::const_iterator RequestListConstIter;
 
} // namespace rxdock
 
#endif //_RBTREQUEST_H_