1 /******************************************************************************
2 * Copyright (c) 2011, Michael P. Gerlek (mpg@flaxen.com)
3 *
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following
8 * conditions are met:
9 *
10 *     * Redistributions of source code must retain the above copyright
11 *       notice, this list of conditions and the following disclaimer.
12 *     * Redistributions in binary form must reproduce the above copyright
13 *       notice, this list of conditions and the following disclaimer in
14 *       the documentation and/or other materials provided
15 *       with the distribution.
16 *     * Neither the name of Hobu, Inc. or Flaxen Geo Consulting nor the
17 *       names of its contributors may be used to endorse or promote
18 *       products derived from this software without specific prior
19 *       written permission.
20 *
21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
28 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
29 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
31 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
32 * OF SUCH DAMAGE.
33 ****************************************************************************/
34 
35 #pragma once
36 
37 #include <pdal/pdal_export.hpp>
38 #include <pdal/Stage.hpp>
39 
40 #include <map>
41 #include <mutex>
42 #include <string>
43 #include <vector>
44 
45 namespace pdal
46 {
47 
48 class Options;
49 
50 /**
51   This class provides a mechanism for creating Stage objects given a driver
52   name.  Creates stages are owned by the factory and destroyed when the
53   factory is destroyed.  Stages can be explicitly destroyed with destroyStage()
54   if desired.
55 
56   \note  Stage creation is thread-safe.
57 */
58 class PDAL_DLL StageFactory
59 {
60 public:
61     /**
62       Create a stage factory.
63 
64       \param ignored  Ignored argument.
65     */
66     StageFactory(bool ignored = true);
67 
68     /**
69       Infer the reader to use based on a filename.
70 
71       \param filename  Filename that should be analyzed to determine a driver.
72       \return  Driver name or empty string if no reader can be inferred from
73         the filename.
74     */
75     static std::string inferReaderDriver(const std::string& filename);
76 
77     /**
78       Infer the writer to use based on filename extension.
79 
80       \return  Driver name or empty string if no writer can be inferred from
81         the filename.
82     */
83     static std::string inferWriterDriver(const std::string& filename);
84 
85     /**
86       Create a stage and return a pointer to the created stage.
87       The factory takes ownership of any successfully created stage.
88 
89       \param stage_name  Type of stage to by created.
90       \return  Pointer to created stage.
91     */
92     Stage *createStage(const std::string& type);
93 
94     /**
95       Destroy a stage created by this factory.  This doesn't need to be
96       called unless you specifically want to destroy a stage as all stages
97       are destroyed when the factory is destroyed.
98 
99       \param stage  Pointer to stage to destroy.
100     */
101     void destroyStage(Stage *stage);
102 
103 private:
104     StageFactory& operator=(const StageFactory&); // not implemented
105     StageFactory(const StageFactory&); // not implemented
106 
107     std::vector<std::unique_ptr<Stage>> m_ownedStages;
108     std::mutex m_mutex;
109 };
110 
111 } // namespace pdal
112 
113