 |
ReFRACtor
|
|
ReFRACtor
|
This class maintains the ground portion of the state. More...
#include <ground.h>
Inheritance diagram for FullPhysics::Ground: Collaboration diagram for FullPhysics::Ground:Public Member Functions | |
| virtual | ~Ground () |
| virtual void | add_observer (Observer< Ground > &Obs) |
| Add an observer. More... | |
| void | add_observer_and_keep_reference (boost::shared_ptr< Observer< Ground > > &Obs) |
| Add an observer and keep a reference to it. More... | |
| virtual boost::shared_ptr< Ground > | clone () const =0 |
| Clone a Ground object. More... | |
| virtual void | mark_used (const StateVector &Sv, blitz::Array< bool, 1 > &Used) const |
| Mark elements that we are actively using (i.e., that aren't ignored). More... | |
| virtual void | notify_add (StateVector &Observed_object) |
| Called when an object is added to an Observable. More... | |
| virtual void | notify_add () |
| virtual void | notify_remove (StateVector &Observed_object) |
| Called when an object is removed from an Observable. More... | |
| virtual void | notify_remove () |
| virtual void | notify_update (const StateVector &Observed_object) |
| Called when the Observed object is updated. More... | |
| virtual void | print (std::ostream &Os) const |
| std::string | print_to_string () const |
| Print to string. More... | |
| virtual void | remove_observer (Observer< Ground > &Obs) |
| Remove an observer. More... | |
| virtual void | state_vector_name (const StateVector &Sv, blitz::Array< std::string, 1 > &Sv_name) const |
| Update any portion of the list of the state vector names that apply to this object. More... | |
| virtual ArrayAd< double, 1 > | surface_parameter (const double wn, const int spec_index) const =0 |
| Surface parmeters. More... | |
Protected Member Functions | |
| void | add_observer_do (Observer< Ground > &Obs, Ground &t) |
| Add an observer. More... | |
| void | add_observer_do (Observer< Ground > &Obs) |
| void | clean_dead_ptr () |
| Remove any dead pointers. More... | |
| void | notify_update_do (const Ground &Self) |
| Function to call to notify Observers of a state change. More... | |
| void | remove_observer_do (Observer< Ground > &Obs, Ground &t) |
| Remove an observer. More... | |
| void | remove_observer_do (Observer< Ground > &Obs) |
Protected Attributes | |
| std::list< boost::weak_ptr< Observer< Ground > > > | olist |
| std::vector< boost::shared_ptr< Observer< Ground > > > | ref_list |
This class maintains the ground portion of the state.
Other objects may depend on the ground, and should be updated when the ground is updated. To facilitate that, this class in an Oberverable, and objects can add themselves as Observers to be notified when the ground is updated.
This class is unfortunately a bit hard coded. The surface types are one of a set of enumerations. The surface parameters depend on exactly what the surface type is. These types and parameters map to types and parameters found in the LIDORT and LRAD code, so the hard coding is intrinsic.
Add an observer.
Implements FullPhysics::Observable< Ground >.
|
inlineinherited |
Add an observer and keep a reference to it.
See the discussion in the Observer class description for details.
Definition at line 107 of file observer.h.
|
inlineprotectedinherited |
Add an observer.
Definition at line 148 of file observer.h.
|
inlineprotectedinherited |
Definition at line 159 of file observer.h.
|
inlineprotectedinherited |
Remove any dead pointers.
Definition at line 196 of file observer.h.
|
pure virtual |
Clone a Ground object.
Note that the cloned version will not be attached to a StateVector, although you can of course attach them after receiving the cloned object.
Because this isn't attached to the StateVector, one use of the clone operator is to create a "frozen" Ground object.
Implemented in FullPhysics::GroundBrdfSoil, FullPhysics::GroundBrdfVeg, FullPhysics::GroundBrdf, FullPhysics::GroundLambertian, FullPhysics::GroundCoxmunk, and FullPhysics::GroundCoxmunkPlusLambertian.
|
inlinevirtualinherited |
Mark elements that we are actively using (i.e., that aren't ignored).
You only need to mark the ones that are used as true, everything is already initialized as false. Default is to do nothing.
Reimplemented in FullPhysics::SubStateVectorObserver.
Definition at line 26 of file state_vector_observer.h.
|
inlinevirtualinherited |
Called when an object is added to an Observable.
Default is to do nothing.
Reimplemented in FullPhysics::AtmosphereOco, and FullPhysics::SubStateVectorObserver.
Definition at line 47 of file observer.h.
|
inlinevirtualinherited |
Definition at line 48 of file observer.h.
|
inlinevirtualinherited |
Called when an object is removed from an Observable.
Default is to do nothing.
Reimplemented in FullPhysics::AtmosphereOco, and FullPhysics::SubStateVectorObserver.
Definition at line 55 of file observer.h.
|
inlinevirtualinherited |
Definition at line 56 of file observer.h.
|
inlinevirtualinherited |
Called when the Observed object is updated.
Reimplemented in FullPhysics::AtmosphereOco, FullPhysics::RadianceScalingSvFit, FullPhysics::AbsorberAbsco, FullPhysics::AerosolOptical, and FullPhysics::SubStateVectorObserver.
Definition at line 40 of file observer.h.
|
inlineprotectedinherited |
Function to call to notify Observers of a state change.
The object should pass itself to this function, so it can be passed to the Observers.
Definition at line 121 of file observer.h.
|
inlinevirtualinherited |
Reimplemented in FullPhysics::AtmosphereOco, FullPhysics::EmpiricalOrthogonalFunction, FullPhysics::AbsorberAbsco, FullPhysics::SolarAbsorptionAndContinuum, FullPhysics::PressureFixedLevel, FullPhysics::Instrument, FullPhysics::DispersionPolynomial, FullPhysics::GroundBrdf, FullPhysics::AerosolOptical, FullPhysics::SubStateVectorObserver, FullPhysics::RadianceScaling, FullPhysics::IlsInstrument, FullPhysics::AerosolPropertyRhHdf, FullPhysics::IlsConvolution, FullPhysics::RadianceScalingSvFit, FullPhysics::AerosolShapeGaussian, FullPhysics::AerosolPropertyImpBase, FullPhysics::AerosolExtinctionLog, FullPhysics::PressureSigma, FullPhysics::RadianceScalingLinearFit, FullPhysics::AerosolExtinctionLinear, FullPhysics::AerosolExtinctionImpBase, FullPhysics::PressureImpBase, FullPhysics::StokesCoefficientImpBase, FullPhysics::GroundLambertian, FullPhysics::TemperatureImpBase, FullPhysics::AerosolPropertyHdf, FullPhysics::FluorescenceEffect, FullPhysics::AbsorberVmrImpBase, FullPhysics::SolarModel, FullPhysics::InstrumentDoppler, FullPhysics::GroundCoxmunk, FullPhysics::ApplyInstrumentUnits, FullPhysics::GroundCoxmunkPlusLambertian, FullPhysics::AbsorberVmrFixedLevel, FullPhysics::AbsorberVmrFixedLevelScaled, FullPhysics::AbsorberVmrMet, FullPhysics::SubStateVectorProxy, FullPhysics::AbsorberVmrLevel, FullPhysics::AbsorberVmrLevelScaled, FullPhysics::TemperatureFixedLevel, FullPhysics::AbsorberVmrScaled, FullPhysics::StokesCoefficientFraction, FullPhysics::TemperatureMet, FullPhysics::TemperatureLevelOffset, FullPhysics::TemperatureOffset, and FullPhysics::StokesCoefficientConstant.
Definition at line 37 of file state_vector_observer.h.
|
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.
Remove an observer.
Implements FullPhysics::Observable< Ground >.
|
inlineprotectedinherited |
Remove an observer.
Definition at line 173 of file observer.h.
|
inlineprotectedinherited |
Definition at line 181 of file observer.h.
|
inlinevirtualinherited |
Update any portion of the list of the state vector names that apply to this object.
Default is to do nothing.
Reimplemented in FullPhysics::SubStateVectorObserver.
Definition at line 34 of file state_vector_observer.h.
|
pure virtual |
Surface parmeters.
What exactly these parameters mean is determined by the surface type, see the discussion in the comments before the Ground class.
Implemented in FullPhysics::GroundBrdf, FullPhysics::GroundLambertian, FullPhysics::GroundCoxmunk, and FullPhysics::GroundCoxmunkPlusLambertian.
|
protectedinherited |
Definition at line 200 of file observer.h.
|
protectedinherited |
Definition at line 201 of file observer.h.
