NASA Logo
Ocean Color Science Software

ocssw V2022

#include <FileReader.hpp>

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

Public Types

enum  validity { invalid, possibly_valid, valid }
 

Public Member Functions

 FileReader (const std::string &name, const std::string &description)
 
 FileReader (const std::string &name)
 
virtual ~FileReader () override
 
virtual std::vector< std::shared_ptr< Product > > & needs () override
 
virtual validity is_valid_file (const std::string &file, FileReaderHints &hints)
 
validity is_valid_file (const std::string &file)
 
virtual std::unique_ptr< FileReaderinitialize_reader (DataProviderConfiguration &configuration, const std::filesystem::path &path)=0
 
virtual std::set< focs::Attributeget_file_attributes ()=0
 
virtual TileParameters read_next_tile (DataProviderConfiguration &configuration, DataRecord &record)
 
- 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 std::vector< Product > & provides ()
 
virtual void set_needs (std::unordered_set< std::shared_ptr< Product >> &provide)
 
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 104 of file FileReader.hpp.

Member Enumeration Documentation

◆ validity

enum validity
Enumerator
invalid 
possibly_valid 
valid 

Definition at line 109 of file FileReader.hpp.

Constructor & Destructor Documentation

◆ FileReader() [1/2]

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

Definition at line 106 of file FileReader.hpp.

◆ FileReader() [2/2]

FileReader ( const std::string name)
inline

Definition at line 107 of file FileReader.hpp.

◆ ~FileReader()

virtual ~FileReader ( )
inlineoverridevirtual

Definition at line 112 of file FileReader.hpp.

Member Function Documentation

◆ get_file_attributes()

virtual std::set<focs::Attribute> get_file_attributes ( )
pure virtual

◆ initialize_reader()

virtual std::unique_ptr<FileReader> initialize_reader ( DataProviderConfiguration configuration,
const std::filesystem::path &  path 
)
pure virtual

◆ is_valid_file() [1/2]

validity is_valid_file ( const std::string file)
inline

Definition at line 119 of file FileReader.hpp.

◆ is_valid_file() [2/2]

virtual validity is_valid_file ( const std::string file,
FileReaderHints hints 
)
inlinevirtual

Definition at line 118 of file FileReader.hpp.

◆ needs()

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

Reimplemented from DataProvider.

◆ read_next_tile()

virtual TileParameters read_next_tile ( DataProviderConfiguration configuration,
DataRecord record 
)
inlinevirtual

Definition at line 126 of file FileReader.hpp.


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