ReFRACtor
FullPhysics::LogTiming Class Reference

This is a helper class that logs basic timing information to the Logger. More...

#include <log_timing.h>

+ Inheritance diagram for FullPhysics::LogTiming:
+ Collaboration diagram for FullPhysics::LogTiming:

Public Member Functions

 LogTiming ()
 Constructor. More...
 
virtual ~LogTiming ()
 
virtual void notify_add (ConnorSolver &Observed_object)
 Called when an object is added to an Observable. More...
 
virtual void notify_add ()
 
virtual void notify_remove (ConnorSolver &Observed_object)
 Called when an object is removed from an Observable. More...
 
virtual void notify_remove ()
 
virtual void notify_update (const ConnorSolver &Solver)
 Called when the Observed object is updated. More...
 
virtual void print (std::ostream &Os)
 
std::string print_to_string () const
 Print to string. More...
 
virtual void write_to_log (const std::string &Prefix="") const
 Write data to disk. More...
 

Detailed Description

This is a helper class that logs basic timing information to the Logger.

Definition at line 14 of file log_timing.h.

Constructor & Destructor Documentation

◆ LogTiming()

LogTiming::LogTiming ( )

Constructor.

Definition at line 31 of file log_timing.cc.

◆ ~LogTiming()

virtual FullPhysics::LogTiming::~LogTiming ( )
inlinevirtual

Definition at line 17 of file log_timing.h.

Member Function Documentation

◆ notify_add() [1/2]

virtual void FullPhysics::Observer< ConnorSolver >::notify_add ( ConnorSolver Observed_object)
inlinevirtualinherited

Called when an object is added to an Observable.

Default is to do nothing.

Definition at line 47 of file observer.h.

◆ notify_add() [2/2]

virtual void FullPhysics::Observer< ConnorSolver >::notify_add ( )
inlinevirtualinherited

Definition at line 48 of file observer.h.

◆ notify_remove() [1/2]

virtual void FullPhysics::Observer< ConnorSolver >::notify_remove ( ConnorSolver Observed_object)
inlinevirtualinherited

Called when an object is removed from an Observable.

Default is to do nothing.

Definition at line 55 of file observer.h.

◆ notify_remove() [2/2]

virtual void FullPhysics::Observer< ConnorSolver >::notify_remove ( )
inlinevirtualinherited

Definition at line 56 of file observer.h.

◆ notify_update()

void LogTiming::notify_update ( const ConnorSolver Observed_object)
virtual

Called when the Observed object is updated.

Reimplemented from FullPhysics::Observer< ConnorSolver >.

Definition at line 20 of file log_timing.cc.

◆ print()

virtual void FullPhysics::LogTiming::print ( std::ostream &  Os)
inlinevirtual

Definition at line 19 of file log_timing.h.

◆ print_to_string()

std::string FullPhysics::Printable< LogTiming >::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.

◆ write_to_log()

void LogTiming::write_to_log ( const std::string &  Prefix = "") const
virtual

Write data to disk.

Definition at line 75 of file log_timing.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