dxapplet.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_DXAPPLET_H
#define DXCPP_BINDINGS_DXAPPLET_H

#include "../bindings.h"

namespace dx {
  class DXApplet: public DXDataObject {
  private:
    dx::JSON describe_(const std::string &s)const{return appletDescribe(dxid_,s);}
    void addTypes_(const std::string &UNUSED(s))const{throw DXNotImplementedError("Wrapper for /applet-xxxx/addTypes does not exist");}
    void removeTypes_(const std::string &UNUSED(s))const{throw DXNotImplementedError("Wrapper for /applet-xxxx/removeTypes does not exist");}
    dx::JSON getDetails_(const std::string &s)const{return appletGetDetails(dxid_,s);}
    void setDetails_(const std::string &UNUSED(s))const{throw DXNotImplementedError("Wrapper for /applet-xxxx/setDetails does not exist");}
    void setVisibility_(const std::string &UNUSED(s))const{throw DXNotImplementedError("Wrapper for /applet-xxxx/setVisibility does not exist");}
    void rename_(const std::string &s)const{appletRename(dxid_,s);}
    void setProperties_(const std::string &s)const{appletSetProperties(dxid_,s);}
    void addTags_(const std::string &s)const{appletAddTags(dxid_,s);}
    void removeTags_(const std::string &s)const{appletRemoveTags(dxid_,s);}
    void close_(const std::string &UNUSED(s))const{throw DXNotImplementedError("Wrapper for /applet-xxxx/close does not exist");}
    dx::JSON listProjects_(const std::string &s)const{return appletListProjects(dxid_,s);}

  public:
    // Note: We do not provide applet creation function .. since we want users
    // to use applet_builder for that task.

    // Applet-specific functions
    DXApplet() { }

    DXApplet(const char *dxid, const char *proj=NULL) {
      setIDs(std::string(dxid), (proj == NULL) ? config::CURRENT_PROJECT() : std::string(proj));
    }
   
    DXApplet(const std::string &dxid,
             const std::string &proj=config::CURRENT_PROJECT()) { setIDs(dxid, proj); }
    
    DXApplet(const dx::JSON &dxlink) { setIDs(dxlink); }

    void create(dx::JSON inp);

    DXJob run(const dx::JSON &applet_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;

    DXApplet clone(const std::string &dest_proj_id,
                   const std::string &dest_folder="/") const;

    dx::JSON get() const { return appletGet(dxid_); }

  };
}
#endif