ReFRACtor
FullPhysics::SourceFilesOutput Class Reference

Writes source filenames into the output file. More...

#include <source_files_output.h>

+ Inheritance diagram for FullPhysics::SourceFilesOutput:
+ Collaboration diagram for FullPhysics::SourceFilesOutput:

Public Member Functions

 SourceFilesOutput (const std::string &group_name, const std::vector< std::string > &dataset_names, const std::vector< std::string > &file_names)
 
virtual ~SourceFilesOutput ()
 
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

Writes source filenames into the output file.

Definition at line 12 of file source_files_output.h.

Constructor & Destructor Documentation

◆ SourceFilesOutput()

FullPhysics::SourceFilesOutput::SourceFilesOutput ( const std::string &  group_name,
const std::vector< std::string > &  dataset_names,
const std::vector< std::string > &  file_names 
)
inline

Definition at line 14 of file source_files_output.h.

◆ ~SourceFilesOutput()

virtual FullPhysics::SourceFilesOutput::~SourceFilesOutput ( )
inlinevirtual

Definition at line 16 of file source_files_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 SourceFilesOutput::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 16 of file source_files_output.cc.

◆ register_output_apriori()

virtual void FullPhysics::RegisterOutputBase::register_output_apriori ( const boost::shared_ptr< Output > &  out) const
inlinevirtualinherited

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