NASA Logo
Ocean Color Science Software

ocssw V2022

#include <FileReader.hpp>

Collaboration diagram for FileReaderHints:
[legend]

Public Member Functions

 FileReaderHints ()=default
 
 FileReaderHints (const std::string &path)
 
bool magic_number (const std::string &bytes) const noexcept
 
template<std::size_t N>
bool magic_number (const std::array< int, N > &bytes) const noexcept
 
const std::array< int, 8 > & first_bytes () const noexcept
 
void first_bytes (const std::array< int, 8 > &bytes)
 
uintmax_t size () const noexcept
 
void size (uintmax_t size)
 
const std::stringfilename () const noexcept
 
void filename (const std::string &filename)
 
const std::stringformat () const noexcept
 
void format (const std::string &format)
 
auto & attributes ()
 
bool is_hdf4 () const noexcept
 
bool is_hdf5 () const noexcept
 
bool is_netcdf () const noexcept
 
std::set< Attributeparse_hdf4_metadata (const std::string &)
 

Static Public Attributes

const static std::string core_metadata
 
const static std::string struct_metadata
 
const static std::string archive_metadata
 

Detailed Description

Definition at line 65 of file FileReader.hpp.

Constructor & Destructor Documentation

◆ FileReaderHints() [1/2]

FileReaderHints ( )
default

◆ FileReaderHints() [2/2]

FileReaderHints ( const std::string path)
explicit

Member Function Documentation

◆ attributes()

auto& attributes ( )
inline

Definition at line 85 of file FileReader.hpp.

◆ filename() [1/2]

const std::string& filename ( ) const
inlinenoexcept

Definition at line 79 of file FileReader.hpp.

◆ filename() [2/2]

void filename ( const std::string filename)
inline

Definition at line 80 of file FileReader.hpp.

◆ first_bytes() [1/2]

const std::array<int, 8>& first_bytes ( ) const
inlinenoexcept

Definition at line 73 of file FileReader.hpp.

◆ first_bytes() [2/2]

void first_bytes ( const std::array< int, 8 > &  bytes)
inline

Definition at line 74 of file FileReader.hpp.

◆ format() [1/2]

const std::string& format ( ) const
inlinenoexcept

Definition at line 82 of file FileReader.hpp.

◆ format() [2/2]

void format ( const std::string format)
inline

Definition at line 83 of file FileReader.hpp.

◆ is_hdf4()

bool is_hdf4 ( ) const
noexcept

◆ is_hdf5()

bool is_hdf5 ( ) const
noexcept

◆ is_netcdf()

bool is_netcdf ( ) const
noexcept

◆ magic_number() [1/2]

bool magic_number ( const std::array< int, N > &  bytes) const
noexcept

◆ magic_number() [2/2]

bool magic_number ( const std::string bytes) const
noexcept

◆ parse_hdf4_metadata()

std::set<Attribute> parse_hdf4_metadata ( const std::string )

◆ size() [1/2]

uintmax_t size ( ) const
inlinenoexcept

Definition at line 76 of file FileReader.hpp.

◆ size() [2/2]

void size ( uintmax_t  size)
inline

Definition at line 77 of file FileReader.hpp.

Member Data Documentation

◆ archive_metadata

const static std::string archive_metadata
static

Definition at line 94 of file FileReader.hpp.

◆ core_metadata

const static std::string core_metadata
static

Definition at line 92 of file FileReader.hpp.

◆ struct_metadata

const static std::string struct_metadata
static

Definition at line 93 of file FileReader.hpp.


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