ReFRACtor
FullPhysics::RadianceScalingOutput Class Reference

This registers the portions of the RadianceScaling class that should be written as output. More...

#include <radiance_scaling_output.h>

+ Inheritance diagram for FullPhysics::RadianceScalingOutput:
+ Collaboration diagram for FullPhysics::RadianceScalingOutput:

Public Member Functions

 RadianceScalingOutput (const boost::shared_ptr< RadianceScaling > &Rad_scaling, const std::string &Hdf_band_name)
 
virtual ~RadianceScalingOutput ()
 
virtual std::string desc () const
 Description of object, to be printed to stream. More...
 
virtual void print (std::ostream &Os) const
 Print to stream. More...
 
std::string print_to_string () const
 Print to string. More...
 
virtual void register_output (const boost::shared_ptr< Output > &out) const
 Register portions of class that will be written to output. More...
 
virtual void register_output_apriori (const boost::shared_ptr< Output > &out) const
 Register apriori portions of class. More...
 

Detailed Description

This registers the portions of the RadianceScaling class that should be written as output.

Definition at line 11 of file radiance_scaling_output.h.

Constructor & Destructor Documentation

◆ RadianceScalingOutput()

FullPhysics::RadianceScalingOutput::RadianceScalingOutput ( const boost::shared_ptr< RadianceScaling > &  Rad_scaling,
const std::string &  Hdf_band_name 
)
inline

Definition at line 13 of file radiance_scaling_output.h.

◆ ~RadianceScalingOutput()

virtual FullPhysics::RadianceScalingOutput::~RadianceScalingOutput ( )
inlinevirtual

Definition at line 17 of file radiance_scaling_output.h.

Member Function Documentation

◆ desc()

virtual std::string FullPhysics::RegisterOutputBase::desc ( ) const
inlinevirtualinherited

Description of object, to be printed to stream.

This gives a cleaner interface for deriving from python.

Reimplemented in FullPhysics::HighResSpectrumOutput.

Definition at line 83 of file register_output_base.h.

◆ print()

virtual void FullPhysics::RegisterOutputBase::print ( std::ostream &  Os) const
inlinevirtualinherited

Print to stream.

The default calls the function "desc" that returns a string. This gives cleaner interface for deriving from this class in python, but most C++ classes will want to override this function rather than using desc.

Definition at line 76 of file register_output_base.h.

◆ print_to_string()

std::string FullPhysics::Printable< RegisterOutputBase >::print_to_string ( ) const
inlineinherited

Print to string.

This is primarily useful for SWIG wrappers to this class, e.g. a to_s method in ruby.

Definition at line 31 of file printable.h.

◆ register_output()

void RadianceScalingOutput::register_output ( const boost::shared_ptr< Output > &  out) const
virtual

Register portions of class that will be written to output.

This is for the final statevector, for classes where apriori and final are written out different.

Implements FullPhysics::RegisterOutputBase.

Definition at line 37 of file radiance_scaling_output.cc.

◆ register_output_apriori()

void RadianceScalingOutput::register_output_apriori ( const boost::shared_ptr< Output > &  out) const
virtual

Register apriori portions of class.

The default is not to have anything written out, but derived classes can override this.

Note that by convention that we "freeze" the state of the class when we register the apriori_output. This allows for things like the StateVector to be changed after wards without changing the apriori state.

Reimplemented from FullPhysics::RegisterOutputBase.

Definition at line 28 of file radiance_scaling_output.cc.


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

Copyright © 2017, California Institute of Technology.
ALL RIGHTS RESERVED.
U.S. Government Sponsorship acknowledged.
Generated Fri Aug 24 2018 15:44:13