TECA
The Toolkit for Extreme Climate Analysis
teca_dataset_capture.h
1 #ifndef teca_dataset_capture_h
2 #define teca_dataset_capture_h
3 
4 #include "teca_config.h"
5 #include "teca_algorithm.h"
6 #include "teca_metadata.h"
7 #include "teca_dataset.h"
8 #include "teca_shared_object.h"
9 
10 TECA_SHARED_OBJECT_FORWARD_DECL(teca_dataset_capture)
11 
12 /** @brief
13  * An algorithm that takes a reference to dataset produced
14  * by the upstream algorithm it is connected to.
15  *
16  * @details
17  * The dataset is passed through so that this can be inserted
18  * anywhere giving one access to the intermediate data.
19  */
21 {
22 public:
23  TECA_ALGORITHM_STATIC_NEW(teca_dataset_capture)
24  TECA_ALGORITHM_DELETE_COPY_ASSIGN(teca_dataset_capture)
25  TECA_ALGORITHM_CLASS_NAME(teca_dataset_capture)
27 
28  // report/initialize to/from Boost program options
29  // objects.
30  TECA_GET_ALGORITHM_PROPERTIES_DESCRIPTION()
31  TECA_SET_ALGORITHM_PROPERTIES()
32 
33  // set/get the dataset from the last pipeline update
34  TECA_ALGORITHM_PROPERTY(const_p_teca_dataset, dataset)
35 
36 protected:
38 
39 private:
40  const_p_teca_dataset execute(unsigned int port,
41  const std::vector<const_p_teca_dataset> &input_data,
42  const teca_metadata &request) override;
43 
44 private:
45  const_p_teca_dataset dataset;
46 };
47 
48 #endif
teca_metadata
A generic container for meta data in the form of name=value pairs.
Definition: teca_metadata.h:21
teca_dataset_capture
An algorithm that takes a reference to dataset produced by the upstream algorithm it is connected to.
Definition: teca_dataset_capture.h:20
teca_shared_object.h
teca_error::TECA_EXPORT
p_teca_error_handler error_handler TECA_EXPORT
The global error handler instance.
teca_algorithm
The interface to TECA pipeline architecture.
Definition: teca_algorithm.h:237