OB.DAAC Logo
NASA Logo
Ocean Color Science Software

ocssw V2022

#include <FileWriter.hpp>

Inheritance diagram for FileWriter:
[legend]
Collaboration diagram for FileWriter:
[legend]

Public Types

enum  validity { invalid, possibly_valid, valid }
 

Public Member Functions

 FileWriter (const std::string &name, const std::string &description)
 
 FileWriter (const std::string &name)
 
virtual ~FileWriter () override
 
virtual std::vector< Product > & provides () override
 
virtual std::unique_ptr< FileWriterinitialize_writer (DataProviderConfiguration &configuration, const std::string &group)=0
 
virtual validity can_process_output_group (focs::DataProviderConfiguration &configuration, const std::string &group)
 
- Public Member Functions inherited from DataProvider
 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 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)
 

Additional Inherited Members

- Static Public Member Functions inherited from DataProvider
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 16 of file FileWriter.hpp.

Member Enumeration Documentation

◆ validity

enum validity
Enumerator
invalid 
possibly_valid 
valid 

Definition at line 29 of file FileWriter.hpp.

Constructor & Destructor Documentation

◆ FileWriter() [1/2]

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

Definition at line 18 of file FileWriter.hpp.

◆ FileWriter() [2/2]

FileWriter ( const std::string name)
inline

Definition at line 19 of file FileWriter.hpp.

◆ ~FileWriter()

virtual ~FileWriter ( )
inlineoverridevirtual

Definition at line 21 of file FileWriter.hpp.

Member Function Documentation

◆ can_process_output_group()

virtual validity can_process_output_group ( focs::DataProviderConfiguration configuration,
const std::string group 
)
inlinevirtual

Definition at line 32 of file FileWriter.hpp.

◆ initialize_writer()

virtual std::unique_ptr<FileWriter> initialize_writer ( DataProviderConfiguration configuration,
const std::string group 
)
pure virtual

◆ provides()

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

Reimplemented from DataProvider.


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