NASA Logo
Ocean Color Science Software

ocssw V2022
focs Namespace Reference

Classes

class  Attribute
 
class  AttributeCondition
 
class  AttributeRange
 
class  AttributeReader
 
class  AttributeWild
 
class  BaseVariable
 
class  Command
 
class  ConfigReader
 
class  DataProvider
 
class  DataProviderConfiguration
 
struct  DataProviderPathPart
 
class  DataRecord
 
class  DataRecordProcessor
 
class  DatFile
 
class  DayNightAttribute
 
class  FileLogger
 
class  FileReader
 
class  FileReaderHints
 
class  FileStreamLogger
 
class  FileWriter
 
class  FilterIterator
 
class  FormattedFileLogger
 
class  FormattedStreamLogger
 
class  GeoSpatialBounds
 
class  GroundControlPoints
 
class  KvStore
 
class  LeapSecond
 
class  LeapSecondDatabase
 
struct  LinkedList
 
struct  LinkedList< T, 0 >
 
class  Log
 
class  LogFacility
 
class  Module
 
struct  ModuleConfiguration
 
class  ModuleLoader
 
class  ModuleManager
 
struct  NVector
 
struct  NVector< T, 0 >
 
struct  ProdAttrGeneric
 
class  Product
 
class  RuntimeAttribute
 
struct  SensorDirectory
 
class  ShareTree
 
class  SlopeInterceptScaler
 
class  Stopwatch
 
class  StringUtils
 
struct  TileParameters
 
class  TimePoint
 
class  Variable
 
class  VariableFill
 
class  VariableFillRange
 
class  VariableFillValue
 
class  VariableScaler
 
struct  VisitorAny
 

Enumerations

enum  LogSeverity : int {
  debug = 7, info = 6, notice = 5, warning = 4,
  error = 3, critical = 2, alert = 1, emergency = 0,
  warn = warning, err = error, crit = critical, emerg = emergency,
  min = std::numeric_limits<int>::max(), max = std::numeric_limits<int>::min()
}
 
enum  OcType {
  Char, String, Float, Double,
  LongDouble, Int8, Int16, Int32,
  Int64, Uint8, Uint16, Uint32,
  Uint64, Unknown
}
 
enum  OcGeospatialType { Yes, Line, Pixel, No }
 

Functions

template<typename T >
void insert (std::unordered_set< std::type_index > &found_types)
 
template<typename T >
std::ostream & operator<< (std::ostream &os, const std::vector< T > &data) noexcept
 
template<class T , class F >
std::pair< const std::type_index, std::function< void(ANY const &)> > to_any_visitor (F const &f)
 
std::ostream & operator<< (std::ostream &out, const SensorDirectory &in)
 
template<typename T >
std::ostream & operator<< (std::ostream &os, const Variable< T, 2 > &v)
 

Variables

const std::array< int, 4 > NETCDF1_MAGIC_NUMBER
 
const std::array< int, 4 > NETCDF2_MAGIC_NUMBER
 
const std::array< int, 4 > HDF4_MAGIC_NUMBER
 
const std::array< int, 8 > HDF5_MAGIC_NUMBER
 
template<typename , typename = void>
constexpr bool is_prod_gen_attr {}
 
template<typename , typename = void>
constexpr bool is_iterable {}
 
constexpr auto program_name = "focs"
 
constexpr auto software_version = "1.2.1"
 

Enumeration Type Documentation

◆ LogSeverity

enum LogSeverity : int
strong

Log severities, for use with focs::Log.

https://en.wikipedia.org/wiki/Syslog#Severity_level

Value Severity Keyword Description/Examples 0 Emergency emerg System is unusable This level should not be used by applications. 1 Alert alert Should be corrected immediately Loss of the primary ISP connection. E.g., Ski Haus Delta has not reported status within status_timeout (120) 2 Critical crit Critical conditions A failure in the system's primary application. E.g., Ski Haus Delta reports temperature < low_critical (30) 3 Error err Error conditions E.g., An application has exceeded its file storage limit and attempts to write are failing. E.g., Ski Haus Delta reports temperature < low_error (32) 4 Warning warn May indicate that an error will occur if action is not taken. E.g., A non-root file system has only 2GB remaining. E.g., Ski Haus Delta reports temperature < low_warning (36) 5 Notice notice Events that are unusual, but not error conditions. E.g., Ski Haus Delta reports temperature < low_notice(50) 6 Informational info Normal operational messages that require no action. An application has started, paused or ended successfully. E.g., Ski Haus Delta reports temperature 60 7 Debug debug Information useful to developers for debugging the application.

The meaning of severity levels other than Emergency and Debug are relative to the application. For example, if the purpose of the system is to process transactions to update customer account balance information, an error in the final step should be assigned Alert level. However, an error occurring in an attempt to display the ZIP code of the customer may be assigned Error or even Warning level.

Enumerator
debug 

debug severity

info 

info severity

notice 

notice severity

warning 

warning severity

error 

error severity

critical 

critical severity

alert 

alert severity

emergency 

emergency severity

warn 

warning severity (alias for warning)

err 

error severity (alias for error)

crit 

critical severity (alias for critical)

emerg 

emergency severity (alias for emergency)

min 

minimum severity possible

max 

maximum severity possible

Definition at line 45 of file Base.hpp.

◆ OcGeospatialType

enum OcGeospatialType
strong
Enumerator
Yes 
Line 
Pixel 
No 

Definition at line 22 of file Variable.hpp.

◆ OcType

enum OcType
strong
Enumerator
Char 
String 
Float 
Double 
LongDouble 
Int8 
Int16 
Int32 
Int64 
Uint8 
Uint16 
Uint32 
Uint64 
Unknown 

Definition at line 15 of file Variable.hpp.

Function Documentation

◆ insert()

void focs::insert ( std::unordered_set< std::type_index > &  found_types)

Definition at line 75 of file Product.hpp.

◆ operator<<() [1/3]

std::ostream& focs::operator<< ( std::ostream &  os,
const std::vector< T > &  data 
)
noexcept

Definition at line 159 of file Product.hpp.

◆ operator<<() [2/3]

std::ostream& focs::operator<< ( std::ostream &  os,
const Variable< T, 2 > &  v 
)

Definition at line 304 of file Variable.hpp.

◆ operator<<() [3/3]

std::ostream& focs::operator<< ( std::ostream &  out,
const SensorDirectory in 
)

◆ to_any_visitor()

std::pair<const std::type_index, std::function<void(ANY const&)> > focs::to_any_visitor ( F const f)
inline

Definition at line 169 of file Product.hpp.

Variable Documentation

◆ HDF4_MAGIC_NUMBER

const std::array<int, 4> HDF4_MAGIC_NUMBER

◆ HDF5_MAGIC_NUMBER

const std::array<int, 8> HDF5_MAGIC_NUMBER

◆ is_iterable

constexpr bool is_iterable {}
constexpr

Definition at line 152 of file Product.hpp.

◆ is_prod_gen_attr

constexpr bool is_prod_gen_attr {}
constexpr

Definition at line 41 of file FileReader.hpp.

◆ NETCDF1_MAGIC_NUMBER

const std::array<int, 4> NETCDF1_MAGIC_NUMBER

◆ NETCDF2_MAGIC_NUMBER

const std::array<int, 4> NETCDF2_MAGIC_NUMBER

◆ program_name

constexpr auto program_name = "focs"
inlineconstexpr

Definition at line 3 of file Version.hpp.

◆ software_version

constexpr auto software_version = "1.2.1"
inlineconstexpr

Definition at line 4 of file Version.hpp.