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

#include <state_vector_output.h>

Inheritance diagram for FullPhysics::StateVectorOutput:

Collaboration diagram for FullPhysics::StateVectorOutput:

Public Member Functions
	StateVectorOutput (const boost::shared_ptr< StateVector > &Sv)

virtual	~StateVectorOutput ()

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 StateVector class that should be written as output.

Note that somewhat surprisingly, we don't use the StateVector object to write out the state vector results and covariance. This is because although the Solver may have a solution, the actual StateVector may or may not be set to this final value. Instead, we output these values from the Solver in SolverOutput, and StateVector just handles the state vector element names.

See the discussion in RegisterOutputBase why this isn't just part of the StateVector class.

Definition at line 21 of file state_vector_output.h.

Constructor & Destructor Documentation

◆ StateVectorOutput()

FullPhysics::StateVectorOutput::StateVectorOutput ( const boost::shared_ptr< StateVector > & Sv )

inline

Definition at line 23 of file state_vector_output.h.

◆ ~StateVectorOutput()

virtual FullPhysics::StateVectorOutput::~StateVectorOutput ( )

inlinevirtual

Definition at line 24 of file state_vector_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 StateVectorOutput::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 19 of file state_vector_output.cc.

◆ register_output_apriori()

void StateVectorOutput::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 13 of file state_vector_output.cc.

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

RegisterOutput/state_vector_output.h
RegisterOutput/state_vector_output.cc

Public Member Functions