OpalSample.h

Go to the documentation of this file.

#ifndef OPAL_SAMPLE_H
#define OPAL_SAMPLE_H

#include <string>
#include <memory>
#include "AbstractObjects/Definition.h"

#include "Sample/SamplingMethod.h"

// Class OpalSample
// ------------------------------------------------------------------------
//  A SAMPLING definition is used run the optimizer in sample mode.

class OpalSample: public Definition {

public:

    OpalSample();

    virtual ~OpalSample() {};

    virtual OpalSample *clone(const std::string &name);

    virtual void execute();

    static OpalSample *find(const std::string &name);

    void initialize(const std::string &dvarName,
                    double lower,
                    double upper,
                    size_t modulo = 1,
                    bool sequence = false);

    std::string getVariable() const;

    unsigned int getSize() const;

    std::shared_ptr<SamplingMethod> sampleMethod_m;

private:

    OpalSample  (const OpalSample &) = delete;
    void operator=(const OpalSample &) = delete;
    OpalSample(const std::string &name, OpalSample *parent);

    unsigned int size_m;
};

inline
unsigned int OpalSample::getSize() const{
    return size_m;
}
#endif