lsst.daf.persistence
14.0-14-g87d16e8+12
include
lsst
daf
persistence
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 <memory>
57
#include <string>
58
#include <typeinfo>
59
60
#include "
lsst/daf/base/Citizen.h
"
61
#include "
lsst/daf/base/PropertySet.h
"
62
#include "
lsst/daf/persistence/FormatterStorage.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
79
class
Formatter
:
public
lsst::daf::base::Citizen
{
80
public
:
81
typedef
std::shared_ptr<Formatter>
Ptr
;
82
85
typedef
Ptr (*FactoryPtr)(
lsst::pex::policy::Policy::Ptr
);
86
87
88
virtual
~
Formatter
(
void
);
89
96
virtual
void
write(
97
lsst::daf::base::Persistable
const
* persistable,
FormatterStorage::Ptr
storage,
98
lsst::daf::base::PropertySet::Ptr
additionalData) = 0;
99
106
virtual
lsst::daf::base::Persistable
* read(
107
FormatterStorage::Ptr
storage,
108
lsst::daf::base::PropertySet::Ptr
additionalData) = 0;
109
117
virtual
void
update(
118
lsst::daf::base::Persistable
* persistable,
FormatterStorage::Ptr
storage,
119
lsst::daf::base::PropertySet::Ptr
additionalData) = 0;
120
121
static
Formatter::Ptr
lookupFormatter(
122
std::string
const
& persistableType,
123
lsst::pex::policy::Policy::Ptr
policy);
124
static
Formatter::Ptr
lookupFormatter(
125
std::type_info
const
& persistableType,
126
lsst::pex::policy::Policy::Ptr
policy);
127
128
protected
:
129
explicit
Formatter
(
std::type_info
const
& type);
130
};
131
138
class
FormatterRegistration
{
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
lsst::pex::policy::Policy::Ptr
std::shared_ptr< Policy > Ptr
std::shared_ptr
lsst::daf::persistence::Formatter::Ptr
std::shared_ptr< Formatter > Ptr
Definition:
Formatter.h:81
FormatterStorage.h
Interface for FormatterStorage abstract base class.
lsst::daf::persistence::FormatterRegistration
Construct a static instance of this helper class to register a Formatter subclass in the FormatterReg...
Definition:
Formatter.h:138
std::type_info
std::string
STL class.
lsst
lsst::daf::persistence::Formatter
Abstract base class for all formatters.
Definition:
Formatter.h:79
Citizen.h
policy.h
PropertySet.h
lsst::daf::base::Persistable
lsst::daf::base::Citizen
Generated on Wed Apr 4 2018 21:37:09 for lsst.daf.persistence by
1.8.13