dxapp.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_DXAPP_H
#define DXCPP_BINDINGS_DXAPP_H
 
#include "../bindings.h"
 
namespace dx {
  class DXApp {
  private:
    std::string dxid_;
    std::string name_;
    std::string alias_;
 
  public:
    // App-specific functions
    DXApp() { }
 
    DXApp(const std::string &nameOrID,
          const std::string &alias="default") {
      setID(nameOrID, alias);
    }
 
    void setID(const std::string &nameOrID, const std::string &alias="default") {
      if (nameOrID.find("app-") == 0) {
        dxid_ = nameOrID;
        name_ = "";
        alias_ = "";
      } else {
        dxid_ = "";
        name_ = nameOrID;
        alias_ = alias;
      }
    }
 
    dx::JSON describe() const;
 
    void update(const dx::JSON &to_update) const;
 
    void addCategories(const dx::JSON &categories) const;
 
    void removeCategories(const dx::JSON &categories) const;
 
    void addTags(const dx::JSON &tags) const;
 
    void removeTags(const dx::JSON &tags) const;
 
    void install() const;
 
    void uninstall() const;
 
    dx::JSON get() const;
 
    void publish(bool makeDefault=false) const;
 
    void remove() const;
 
    DXJob run(const dx::JSON &app_input,
              const std::string &output_folder="/", 
              const std::vector<std::string> &depends_on=std::vector<std::string>(),
              const dx::JSON &instance_type=dx::JSON(dx::JSON_NULL),
              const std::string &project_context=config::CURRENT_PROJECT()
              ) const;
  };
}
#endif