PolicyConfigured.h

Go to the documentation of this file.

// -*- lsst-c++ -*-

/*
 * LSST Data Management System
 * Copyright 2008, 2009, 2010 LSST Corporation.
 *
 * This product includes software developed by the
 * LSST Project (http://www.lsst.org/).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the LSST License Statement and
 * the GNU General Public License along with this program.  If not,
 * see <http://www.lsstcorp.org/LegalNotices/>.
 */

#ifndef LSST_PEX_POLICY_POLICYCONFIGURED_H
#define LSST_PEX_POLICY_POLICYCONFIGURED_H

#include "lsst/pex/policy/PolicyFile.h"
#include "lsst/pex/policy/Policy.h"

namespace lsst {
namespace pex {
namespace policy {

class PolicyConfigured {
public:
    typedef Policy::Ptr PolicyPtr;
    typedef Policy::ConstPtr ConstPolicyPtr;
    typedef std::shared_ptr<PolicySource> PolicySourcePtr;

    PolicyConfigured(const PolicyPtr& policy) : _policy(policy) {}

    PolicyConfigured() : _policy() {}

    virtual ~PolicyConfigured();

    ConstPolicyPtr getPolicy() const { return _policy; }

    bool isConfigured() const { return _configured; }

    static PolicySourcePtr getDefaultPolicySource() { return PolicySourcePtr(); }

protected:
    PolicyPtr getPolicy() { return _policy; }

    void forgetPolicy() { _policy.reset((Policy*)0); }

    void configured() { _configured = true; }

    virtual void done();

private:
    PolicyPtr _policy;
    bool _configured;
};

}  // namespace policy
}  // namespace pex
}  // namespace lsst

#endif  // LSST_PEX_POLICY_POLICYCONFIGURED_H