LSSTApplications  10.0-2-g4f67435,11.0.rc2+1,11.0.rc2+12,11.0.rc2+3,11.0.rc2+4,11.0.rc2+5,11.0.rc2+6,11.0.rc2+7,11.0.rc2+8
LSSTDataManagementBasePackage
Formatter.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 
25 #ifndef LSST_MWI_PERSISTENCE_FORMATTER_H
26 #define LSST_MWI_PERSISTENCE_FORMATTER_H
27 
56 #include <boost/shared_ptr.hpp>
57 #include <string>
58 #include <typeinfo>
59 
60 #include "lsst/daf/base/Citizen.h"
63 #include "lsst/pex/policy.h"
64 
65 namespace lsst {
66 namespace daf {
67 namespace base {
68 
69 class Persistable;
70 
71 } // namespace lsst::daf::base
72 
73 namespace persistence {
74 
75 // Forward declarations.
76 class LogicalLocation;
77 
78 
80 public:
81  typedef boost::shared_ptr<Formatter> Ptr;
82 
86 
87 
88  virtual ~Formatter(void);
89 
96  virtual void write(
97  lsst::daf::base::Persistable const* persistable, Storage::Ptr storage,
98  lsst::daf::base::PropertySet::Ptr additionalData) = 0;
99 
107  Storage::Ptr storage,
108  lsst::daf::base::PropertySet::Ptr additionalData) = 0;
109 
117  virtual void update(
118  lsst::daf::base::Persistable* persistable, Storage::Ptr storage,
119  lsst::daf::base::PropertySet::Ptr additionalData) = 0;
120 
122  std::string const& persistableType,
125  std::type_info const& persistableType,
127 
128 protected:
129  explicit Formatter(std::type_info const& type);
130 };
131 
139 public:
140  FormatterRegistration(std::string const& persistableName,
141  std::type_info const& persistableType,
142  Formatter::FactoryPtr factory);
143 };
144 
145 }}} // namespace lsst::daf::persistence
146 
147 #endif
FormatterRegistration(std::string const &persistableName, std::type_info const &persistableType, Formatter::FactoryPtr factory)
Definition: Formatter.cc:56
boost::shared_ptr< Formatter > Ptr
Definition: Formatter.h:81
virtual void write(lsst::daf::base::Persistable const *persistable, Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
boost::shared_ptr< PropertySet > Ptr
Definition: PropertySet.h:90
Formatter(std::type_info const &type)
Definition: Formatter.cc:68
Interface for Storage abstract base class.
virtual void update(lsst::daf::base::Persistable *persistable, Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
boost::shared_ptr< Policy > Ptr
Definition: Policy.h:172
Construct a static instance of this helper class to register a Formatter subclass in the FormatterReg...
Definition: Formatter.h:138
Ptr(* FactoryPtr)(lsst::pex::policy::Policy::Ptr)
Definition: Formatter.h:85
static Formatter::Ptr lookupFormatter(std::string const &persistableType, lsst::pex::policy::Policy::Ptr policy)
Definition: Formatter.cc:84
virtual lsst::daf::base::Persistable * read(Storage::Ptr storage, lsst::daf::base::PropertySet::Ptr additionalData)=0
Abstract base class for all formatters.
Definition: Formatter.h:79
boost::shared_ptr< Storage > Ptr
Definition: Storage.h:62
Interface for PropertySet class.
Base class for all persistable classes.
Definition: Persistable.h:74
Citizen is a class that should be among all LSST classes base classes, and handles basic memory manag...
Definition: Citizen.h:56