/
PipelineManager.hpp
178 lines (152 loc) · 5.95 KB
/
PipelineManager.hpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
/******************************************************************************
* Copyright (c) 2011, Michael P. Gerlek (mpg@flaxen.com)
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following
* conditions are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided
* with the distribution.
* * Neither the name of Hobu, Inc. or Flaxen Geo Consulting nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
* OF SUCH DAMAGE.
****************************************************************************/
#pragma once
#include <pdal/PointTable.hpp>
#include <pdal/PointView.hpp>
#include <pdal/Options.hpp>
#include <pdal/Log.hpp>
#include <vector>
#include <string>
namespace pdal
{
struct QuickInfo;
class Stage;
class StageFactory;
struct StageCreationOptions
{
std::string m_filename;
std::string m_driver;
Stage *m_parent;
Options m_options;
std::string m_tag;
};
class PDAL_DLL PipelineManager
{
FRIEND_TEST(json, tags);
public:
struct ExecResult
{
ExecResult() : m_mode(ExecMode::None), m_count(0)
{}
ExecResult(ExecMode mode, point_count_t count) :
m_mode(mode), m_count(count)
{}
ExecMode m_mode;
point_count_t m_count;
};
PipelineManager(point_count_t streamLimit = 10000);
~PipelineManager();
void setProgressFd(int fd)
{ m_progressFd = fd; }
void readPipeline(std::istream& input);
void readPipeline(const std::string& filename);
// Use these to manually add stages into the pipeline manager.
Stage& addReader(const std::string& type);
Stage& addFilter(const std::string& type);
Stage& addWriter(const std::string& type);
// These add stages, hook dependencies and set necessary options.
// They're preferable to the above as they're more flexible and safer.
Stage& makeReader(const std::string& inputFile, std::string driver);
Stage& makeReader(const std::string& inputFile, std::string driver,
Options options);
Stage& makeReader(StageCreationOptions& opts);
Stage& makeFilter(const std::string& driver);
Stage& makeFilter(const std::string& driver, Options options);
Stage& makeFilter(const std::string& driver, Stage& parent);
Stage& makeFilter(const std::string& driver, Stage& parent,
Options options);
Stage& makeFilter(StageCreationOptions& ops);
Stage& makeWriter(const std::string& outputFile, std::string driver);
Stage& makeWriter(const std::string& outputFile, std::string driver,
Options options);
Stage& makeWriter(const std::string& outputFile, std::string driver,
Stage& parent);
Stage& makeWriter(const std::string& outputFile, std::string driver,
Stage& parent, Options options);
Stage& makeWriter(StageCreationOptions& ops);
// Return the first leaf stage of a pipeline, or nullptr if the pipeline
// is empty.
Stage* getStage() const
{
const auto& llist = leaves();
return llist.size() ? llist[0] : nullptr;
}
// Set the log to be available to stages.
void setLog(const LogPtr& log);
LogPtr log() const;
QuickInfo preview() const;
void prepare() const;
ExecResult execute(ExecMode mode);
point_count_t execute();
void executeStream(StreamPointTable& table);
void validateStageOptions() const;
bool pipelineStreamable() const;
bool hasReader() const;
// Get the resulting point views.
const PointViewSet& views() const
{ return m_viewSet; }
// Get the point table data.
PointTableRef pointTable() const
{ return m_table; }
MetadataNode getMetadata() const;
Options& commonOptions()
{ return m_commonOptions; }
OptionsMap& stageOptions()
{ return m_stageOptions; }
std::vector<Stage *> roots() const;
std::vector<Stage *> leaves() const;
void replace(Stage *sOld, Stage *sNew);
const std::vector<Stage *> stages() const
{ return m_stages; }
void destroyStage(Stage *s = nullptr);
private:
void setOptions(Stage& stage, const Options& addOps);
Options stageOptions(Stage& stage);
std::unique_ptr<StageFactory> m_factory;
std::unique_ptr<SimplePointTable> m_tablePtr;
PointTableRef m_table;
std::unique_ptr<FixedPointTable> m_streamTablePtr;
StreamPointTable& m_streamTable;
Options m_commonOptions;
OptionsMap m_stageOptions;
PointViewSet m_viewSet;
std::vector<Stage*> m_stages; // stage observer, never owner
int m_progressFd;
std::istream *m_input;
LogPtr m_log;
PipelineManager& operator=(const PipelineManager&); // not implemented
PipelineManager(const PipelineManager&); // not implemented
};
typedef std::unique_ptr<PipelineManager> PipelineManagerPtr;
} // namespace pdal