LSSTApplications  16.0-10-g0ee56ad+5,16.0-11-ga33d1f2+5,16.0-12-g3ef5c14+3,16.0-12-g71e5ef5+18,16.0-12-gbdf3636+3,16.0-13-g118c103+3,16.0-13-g8f68b0a+3,16.0-15-gbf5c1cb+4,16.0-16-gfd17674+3,16.0-17-g7c01f5c+3,16.0-18-g0a50484+1,16.0-20-ga20f992+8,16.0-21-g0e05fd4+6,16.0-21-g15e2d33+4,16.0-22-g62d8060+4,16.0-22-g847a80f+4,16.0-25-gf00d9b8+1,16.0-28-g3990c221+4,16.0-3-gf928089+3,16.0-32-g88a4f23+5,16.0-34-gd7987ad+3,16.0-37-gc7333cb+2,16.0-4-g10fc685+2,16.0-4-g18f3627+26,16.0-4-g5f3a788+26,16.0-5-gaf5c3d7+4,16.0-5-gcc1f4bb+1,16.0-6-g3b92700+4,16.0-6-g4412fcd+3,16.0-6-g7235603+4,16.0-69-g2562ce1b+2,16.0-8-g14ebd58+4,16.0-8-g2df868b+1,16.0-8-g4cec79c+6,16.0-8-gadf6c7a+1,16.0-8-gfc7ad86,16.0-82-g59ec2a54a+1,16.0-9-g5400cdc+2,16.0-9-ge6233d7+5,master-g2880f2d8cf+3,v17.0.rc1
LSSTDataManagementBasePackage
PolicyConfigured.h
Go to the documentation of this file.
1 // -*- lsst-c++ -*-
2 
3 /*
4  * LSST Data Management System
5  * Copyright 2008, 2009, 2010 LSST Corporation.
6  *
7  * This product includes software developed by the
8  * LSST Project (http://www.lsst.org/).
9  *
10  * This program is free software: you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation, either version 3 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the LSST License Statement and
21  * the GNU General Public License along with this program. If not,
22  * see <http://www.lsstcorp.org/LegalNotices/>.
23  */
24 
32 #ifndef LSST_PEX_POLICY_POLICYCONFIGURED_H
33 #define LSST_PEX_POLICY_POLICYCONFIGURED_H
34 
36 #include "lsst/pex/policy/Policy.h"
37 
38 namespace lsst {
39 namespace pex {
40 namespace policy {
41 
78 public:
82 
88  PolicyConfigured(const PolicyPtr& policy) : _policy(policy) { }
89 
93  PolicyConfigured() : _policy() { }
94 
98  virtual ~PolicyConfigured();
99 
108  ConstPolicyPtr getPolicy() const { return _policy; }
109 
113  bool isConfigured() const { return _configured; }
114 
121  static PolicySourcePtr getDefaultPolicySource() {
122  return PolicySourcePtr();
123  }
124 
125 protected:
126 
132  PolicyPtr getPolicy() { return _policy; }
133 
137  void forgetPolicy() { _policy.reset((Policy*)0); }
138 
143  void configured() { _configured = true; }
144 
151  virtual void done();
152 
153 private:
154  PolicyPtr _policy;
155  bool _configured;
156 
157 };
158 
159 }}} // end namespace lsst::pex::policy
160 
161 
162 
163 #endif // LSST_PEX_POLICY_POLICYCONFIGURED_H
an interface to indicate that a class is configured with a Policy
PolicyConfigured()
construct without configuration from a policy
definition of the PolicyFile class
std::shared_ptr< PolicySource > PolicySourcePtr
a container for holding hierarchical configuration data in memory.
Definition: Policy.h:169
PolicyPtr getPolicy()
return the policy that should be used to configure this object.
ConstPolicyPtr getPolicy() const
return the policy that is being used to configure this object.
A base class for image defects.
static PolicySourcePtr getDefaultPolicySource()
return a PolicySource pointer that can be used to create a default Policy for instances of this class...
T reset(T... args)
void configured()
indicate that this object is now configured.
PolicyConfigured(const PolicyPtr &policy)
configure this class with a policy.
virtual void done()
indicate that this object is done with the policy provided in the constructor.
virtual ~PolicyConfigured()
delete this interface
bool isConfigured() const
return true if this object has been configured
void forgetPolicy()
set the policy pointer to null