Implementation of ObsIo creating a file. More...

#include <ObsIoFileCreate.h>

Inheritance diagram for ioda::ObsIoFileCreate:

[legend]

Collaboration diagram for ioda::ObsIoFileCreate:

[legend]

Public Types
typedef ObsFileOutParameters	Parameters_
	Type used by ObsIoFactory. More...

Public Member Functions
	ObsIoFileCreate (const Parameters_ &ioParams, const ObsSpaceParameters &obsSpaceParams)

	~ObsIoFileCreate ()

Public Member Functions inherited from ioda::ObsIo
	ObsIo ()

virtual	~ObsIo ()

Dimensions_t	maxVarSize () const
	return number of maximum variable size (along first dimension) More...

Dimensions_t	numLocs () const
	return number of locations from the source More...

Dimensions_t	numVars () const
	return number of regular variables from the source More...

Dimensions_t	numDimVars () const
	return number of dimension scale variables from the source More...

const VarNameObjectList &	varList () const
	return list of regular variable names More...

const VarNameObjectList &	dimVarList () const
	return list of dimension scale variable names More...

VarDimMap	varDimMap () const
	return map of variables to attached dimension scales More...

bool	isVarDimByNlocs (const std::string &varName) const
	return true if variable's first dimension is nlocs More...

Has_Variables &	vars ()
	access to the variables container in the associated ObsGroup More...

Has_Attributes &	atts ()
	access to the attributes container in the associated ObsGroup More...

void	updateVarDimInfo ()
	update the variable and dimension information More...

const std::vector< std::string > &	obsGroupingVars () const
	return the names of variables to be used to group observations into records More...

virtual bool	applyTimingWindow () const
	return true if only observations within the timing window should be retained, false otherwise. More...

virtual bool	eachProcessGeneratesSeparateObs () const
	return true if each process generates a separate series of observations (e.g. read from different files). More...

Static Public Member Functions
static const std::string	classname ()
	classname method for object counter More...

Private Member Functions
void	print (std::ostream &os) const override
	print routine for oops::Printable base class More...

Additional Inherited Members
Protected Attributes inherited from ioda::ObsIo
ObsGroup	obs_group_
	ObsGroup object representing io source/destination. More...

Dimensions_t	max_var_size_
	maximum variable size (ie, first dimension size) More...

Dimensions_t	nlocs_
	number of locations from source (file or generator) More...

VarNameObjectList	var_list_
	list of regular variables from source (file or generator) More...

VarNameObjectList	dim_var_list_
	list of dimension scale variables from source (file or generator) More...

VarDimMap	dims_attached_to_vars_
	map containing variables with their attached dimension scales More...

std::vector< std::string >	obs_grouping_vars_
	names of variables to be used to group observations into records More...

Detailed Description

Implementation of ObsIo creating a file.

Author: Stephen Herbener (JCSDA)

Definition at line 26 of file ObsIoFileCreate.h.

Member Typedef Documentation

◆ Parameters_

typedef ObsFileOutParameters ioda::ObsIoFileCreate::Parameters_

Type used by ObsIoFactory.

Definition at line 36 of file ObsIoFileCreate.h.

Constructor & Destructor Documentation

◆ ObsIoFileCreate()

ioda::ObsIoFileCreate::ObsIoFileCreate	(	const Parameters_ &	ioParams,
		const ObsSpaceParameters &	obsSpaceParams
	)

explicit

Definition at line 17 of file ObsIoFileCreate.cc.

Here is the call graph for this function:

◆ ~ObsIoFileCreate()

ioda::ObsIoFileCreate::~ObsIoFileCreate ( )

Definition at line 49 of file ObsIoFileCreate.cc.

Member Function Documentation

◆ classname()

static const std::string ioda::ObsIoFileCreate::classname ( )

inlinestatic

classname method for object counter

This method is supplied for the ObjectCounter base class. It defines a name to identify an object of this class for reporting by OOPS.

Definition at line 33 of file ObsIoFileCreate.h.

◆ print()

void ioda::ObsIoFileCreate::print ( std::ostream & os ) const

overrideprivatevirtual

print routine for oops::Printable base class

Parameters

ostream output stream

Implements ioda::ObsIo.

Definition at line 53 of file ObsIoFileCreate.cc.

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

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members