bindings.h

Go to the documentation of this file.

// Copyright (C) 2013-2016 DNAnexus, Inc.
//
// This file is part of dx-toolkit (DNAnexus platform client libraries).
//
//   Licensed under the Apache License, Version 2.0 (the "License"); you may
//   not use this file except in compliance with the License. You may obtain a
//   copy of the License at
//
//       http://www.apache.org/licenses/LICENSE-2.0
//
//   Unless required by applicable law or agreed to in writing, software
//   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
//   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
//   License for the specific language governing permissions and limitations
//   under the License.

#ifndef DXCPP_BINDINGS_H
#define DXCPP_BINDINGS_H

#include <string>
#include <limits>
#include "dxcpp.h"

namespace dx {

  class DXDataObject {
   protected:
    std::string dxid_;
    std::string proj_;
    void waitOnState(const std::string &state="closed",
         const int timeout=std::numeric_limits<int>::max()) const;

    virtual JSON describe_(const std::string &input_params) const = 0;
    virtual void addTypes_(const std::string &input_params) const = 0;
    virtual void removeTypes_(const std::string &input_params) const = 0;
    virtual JSON getDetails_(const std::string &input_params) const = 0;
    virtual void setDetails_(const std::string &input_params) const = 0;
    virtual void setVisibility_(const std::string &input_params) const = 0;
    virtual void rename_(const std::string &input_params) const = 0;
    virtual void setProperties_(const std::string &input_params) const = 0;
    virtual void addTags_(const std::string &input_params) const = 0;
    virtual void removeTags_(const std::string &input_params) const = 0;
    virtual void close_(const std::string &input_params) const = 0;
    virtual JSON listProjects_(const std::string &input_params) const = 0;

    void clone_(const std::string &dest_proj_id,
                const std::string &dest_folder) const;

   public:
    DXDataObject() { }

    DXDataObject(const DXDataObject &to_copy) {
      dxid_ = to_copy.dxid_;
      proj_ = to_copy.proj_;
    }

    DXDataObject(const std::string &dxid) { setIDs(dxid); }

    DXDataObject(const std::string &dxid, const std::string &proj) {
      setIDs(dxid, proj);
    }

    std::string getID() const { return dxid_; }

    operator std::string() { return dxid_; }

    std::string getProjectID() const { return proj_; }

    virtual void setIDs(const std::string &dxid, const std::string &proj="default");

    virtual void setIDs(const char *dxid, const char *proj=NULL);

    virtual void setIDs(const JSON &dxlink);

    JSON describe(bool incl_properties=false, bool incl_details=false) const;

    void addTypes(const JSON &types) const;

    void removeTypes(const JSON &types) const;

    JSON getDetails() const;

    void setDetails(const JSON &details) const;

    void hide() const;

    void unhide() const;

    void rename(const std::string &name) const;

    void setProperties(const JSON &properties) const;

    JSON getProperties() const;

    void addTags(const JSON &tags) const;

    void removeTags(const JSON &tags) const;

    virtual void close() const;

    JSON listProjects() const;

    void move(const std::string &dest_folder) const;

    void remove();
  };

  JSON DXLink(const std::string &dxid, const std::string &proj="");
}

#include "bindings/dxrecord.h"
#include "bindings/dxfile.h"
#include "bindings/dxjob.h"
#include "bindings/dxapplet.h"
#include "bindings/dxapp.h"
#include "bindings/dxproject.h"
#include "bindings/search.h"

#endif