Algorithm.h

Go to the documentation of this file.

#ifndef __BUSBOY_ALGORITHM_H__
#define __BUSBOY_ALGORITHM_H__

#include <string>
#include "AlgorithmData.h"
#include "context/context_api.h"
#include "keys/keys_api.h"

namespace BUSBOY {

class AlgorithmImpl;

class Algorithm {

        public:

                virtual void executeAlgorithm(AlgorithmData& data, AlgorithmContext& context) =0;

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

                void addInputDataset(const std::string& name, bool optional);

                void addInputDataset(const std::string& name, bool optional, bool excludeFromKeyspace);

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

                std::set<std::string> getInputDatasets() const;

                std::set<std::string> getRequiredInputDatasets() const;

                std::set<std::string> getOptionalInputDatasets() const;

                std::set<std::string> getExcludedInputDatasets() const;

                std::set<std::string> getOutputDatasets() const;

                bool isInputDatasetOptional(const std::string& name) const;

                bool isInputDatasetExcludedFromKeyspace(const std::string& name) const;

                void addExpectedDimension(const DataKeyDimension& dim);

                std::set<DataKeyDimension> getExpectedDimensions() const;


                ~Algorithm();

        protected:

                Algorithm();

        private:

                AlgorithmImpl* m_impl;
                

};

}

#endif