OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <DataProvider.hpp>

Inheritance diagram for DataProvider:
[legend]

Public Member Functions

 DataProvider (const std::string &name, const std::string &description)
 
 DataProvider (const std::string &name)
 
virtual ~DataProvider ()
 
const std::stringname () const
 
const std::stringdescription () const
 
virtual void pre_initialize (DataProviderConfiguration &configuration)
 
virtual void initialize (DataProviderConfiguration &configuration, std::unordered_set< Product * > &provide)
 
virtual void post_initialize (DataProviderConfiguration &configuration)
 
virtual void finalize ()
 
virtual void process_tile (DataProviderConfiguration &configuration, DataRecord &data_record, TileParameters &tile_params)=0
 
virtual std::vector< Product > & provides ()
 
virtual void set_needs (std::unordered_set< std::shared_ptr< Product >> &provide)
 
virtual std::vector< std::shared_ptr< Product > > & needs ()
 
virtual std::vector< std::shared_ptr< Product > > needs (std::unordered_set< Product * > &provide)
 
virtual size_t kernel_size () const
 
virtual bool fulfills (const Product &other)
 
bool fulfills (const std::vector< std::shared_ptr< Product >> &other)
 
bool fulfills (DataProvider &other)
 
bool is_fulfilled_by (const std::vector< Product > &other)
 
bool is_fulfilled_by (DataProvider &other)
 
bool partially_fulfills (const Product &other)
 
bool partially_fulfills (const std::vector< std::shared_ptr< Product >> &other)
 
bool partially_fulfills (DataProvider &other)
 
bool partially_fulfills (const std::vector< DataProvider * > other)
 
bool is_partially_fulfilled_by (const std::vector< Product > &other)
 
bool is_partially_fulfilled_by (DataProvider &other)
 
bool is_partially_fulfilled_by (const Product &other)
 

Static Public Member Functions

static std::vector< std::shared_ptr< DataProviderPathPart > > processing_paths (KvStore &configuration, std::vector< DataProvider * > &input, std::vector< DataProvider * > &data_providers, std::vector< DataProvider * > &output)
 

Detailed Description

Definition at line 59 of file DataProvider.hpp.

Constructor & Destructor Documentation

◆ DataProvider() [1/2]

DataProvider ( const std::string name,
const std::string description 
)
inline

Definition at line 61 of file DataProvider.hpp.

◆ DataProvider() [2/2]

DataProvider ( const std::string name)
inline

Definition at line 62 of file DataProvider.hpp.

◆ ~DataProvider()

virtual ~DataProvider ( )
virtual

Member Function Documentation

◆ description()

const std::string& description ( ) const
inline

Definition at line 67 of file DataProvider.hpp.

◆ finalize()

virtual void finalize ( )
inlinevirtual

Definition at line 74 of file DataProvider.hpp.

◆ fulfills() [1/3]

virtual bool fulfills ( const Product other)
inlinevirtual

Definition at line 92 of file DataProvider.hpp.

◆ fulfills() [2/3]

bool fulfills ( const std::vector< std::shared_ptr< Product >> &  other)
inline

Definition at line 95 of file DataProvider.hpp.

◆ fulfills() [3/3]

bool fulfills ( DataProvider other)
inline

Definition at line 98 of file DataProvider.hpp.

◆ initialize()

virtual void initialize ( DataProviderConfiguration configuration,
std::unordered_set< Product * > &  provide 
)
inlinevirtual

Definition at line 72 of file DataProvider.hpp.

◆ is_fulfilled_by() [1/2]

bool is_fulfilled_by ( const std::vector< Product > &  other)
inline

Definition at line 101 of file DataProvider.hpp.

◆ is_fulfilled_by() [2/2]

bool is_fulfilled_by ( DataProvider other)
inline

Definition at line 104 of file DataProvider.hpp.

◆ is_partially_fulfilled_by() [1/3]

bool is_partially_fulfilled_by ( const Product other)
inline

Definition at line 126 of file DataProvider.hpp.

◆ is_partially_fulfilled_by() [2/3]

bool is_partially_fulfilled_by ( const std::vector< Product > &  other)
inline

Definition at line 119 of file DataProvider.hpp.

◆ is_partially_fulfilled_by() [3/3]

bool is_partially_fulfilled_by ( DataProvider other)
inline

Definition at line 122 of file DataProvider.hpp.

◆ kernel_size()

virtual size_t kernel_size ( ) const
inlinevirtual

Definition at line 86 of file DataProvider.hpp.

◆ name()

const std::string& name ( ) const
inline

Definition at line 66 of file DataProvider.hpp.

◆ needs() [1/2]

virtual std::vector<std::shared_ptr<Product> >& needs ( )
virtual

Reimplemented in FileReader.

◆ needs() [2/2]

virtual std::vector<std::shared_ptr<Product> > needs ( std::unordered_set< Product * > &  provide)
inlinevirtual

Definition at line 81 of file DataProvider.hpp.

◆ partially_fulfills() [1/4]

bool partially_fulfills ( const Product other)
inline

Definition at line 107 of file DataProvider.hpp.

◆ partially_fulfills() [2/4]

bool partially_fulfills ( const std::vector< DataProvider * >  other)
inline

Definition at line 116 of file DataProvider.hpp.

◆ partially_fulfills() [3/4]

bool partially_fulfills ( const std::vector< std::shared_ptr< Product >> &  other)
inline

Definition at line 110 of file DataProvider.hpp.

◆ partially_fulfills() [4/4]

bool partially_fulfills ( DataProvider other)
inline

Definition at line 113 of file DataProvider.hpp.

◆ post_initialize()

virtual void post_initialize ( DataProviderConfiguration configuration)
inlinevirtual

Definition at line 73 of file DataProvider.hpp.

◆ pre_initialize()

virtual void pre_initialize ( DataProviderConfiguration configuration)
inlinevirtual

Definition at line 71 of file DataProvider.hpp.

◆ process_tile()

virtual void process_tile ( DataProviderConfiguration configuration,
DataRecord data_record,
TileParameters tile_params 
)
pure virtual

◆ processing_paths()

static std::vector<std::shared_ptr<DataProviderPathPart> > processing_paths ( KvStore configuration,
std::vector< DataProvider * > &  input,
std::vector< DataProvider * > &  data_providers,
std::vector< DataProvider * > &  output 
)
static

◆ provides()

virtual std::vector<Product>& provides ( )
virtual

Reimplemented in FileWriter.

◆ set_needs()

virtual void set_needs ( std::unordered_set< std::shared_ptr< Product >> &  provide)
inlinevirtual

Definition at line 79 of file DataProvider.hpp.


The documentation for this class was generated from the following file: