casacore
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members

A class to provide a simple interface to history writing. More...

#include <MSHistoryHandler.h>

Public Member Functions

 MSHistoryHandler (MeasurementSet &ms, String app="")
 Construct the history handler from an ms. More...
 
MSHistoryHandleroperator= (MSHistoryHandler &other)
 
 ~MSHistoryHandler ()
 Destructor. More...
 
void addMessage (String message, String cliComm="", String origin="")
 Add message and/or CLI command to the history table. More...
 
void addMessage (LogIO &message, String cliComm="")
 In this version the LogIO object need to have a valid LogSink with messages in it. More...
 
void addMessage (LogSinkInterface &sink, String cliComm="")
 
void cliCommand (String &cliComm)
 
void cliCommand (LogIO &cliComm)
 
void cliCommand (LogSinkInterface &sink)
 

Static Public Member Functions

static void addMessage (MeasurementSet &ms, String message, String app="", String cliComm="", String origin="")
 Add a string message. More...
 

Private Member Functions

 MSHistoryHandler ()
 Prevent use of default constructor. More...
 

Private Attributes

MSHistoryColumnsmsHistCol_p
 
MSHistory histTable_p
 
String application_p
 

Detailed Description

A class to provide a simple interface to history writing.

Intended use:

Internal

Etymology

Handle the history info that needs to be archived in ms

Synopsis

This class provides access to the MS history via single method calls A couple of the simple methods are independent and can be called without constructing.

Definition at line 55 of file MSHistoryHandler.h.

Constructor & Destructor Documentation

§ MSHistoryHandler() [1/2]

casacore::MSHistoryHandler::MSHistoryHandler ( MeasurementSet ms,
String  app = "" 
)

Construct the history handler from an ms.

§ ~MSHistoryHandler()

casacore::MSHistoryHandler::~MSHistoryHandler ( )

Destructor.

§ MSHistoryHandler() [2/2]

casacore::MSHistoryHandler::MSHistoryHandler ( )
inlineprivate

Prevent use of default constructor.

Definition at line 91 of file MSHistoryHandler.h.

Member Function Documentation

§ addMessage() [1/4]

static void casacore::MSHistoryHandler::addMessage ( MeasurementSet ms,
String  message,
String  app = "",
String  cliComm = "",
String  origin = "" 
)
static

Add a string message.

This method does not need construction ...can be called explicitly

§ addMessage() [2/4]

void casacore::MSHistoryHandler::addMessage ( String  message,
String  cliComm = "",
String  origin = "" 
)

Add message and/or CLI command to the history table.

§ addMessage() [3/4]

void casacore::MSHistoryHandler::addMessage ( LogIO message,
String  cliComm = "" 
)

In this version the LogIO object need to have a valid LogSink with messages in it.

§ addMessage() [4/4]

void casacore::MSHistoryHandler::addMessage ( LogSinkInterface sink,
String  cliComm = "" 
)

§ cliCommand() [1/3]

void casacore::MSHistoryHandler::cliCommand ( String cliComm)

§ cliCommand() [2/3]

void casacore::MSHistoryHandler::cliCommand ( LogIO cliComm)

§ cliCommand() [3/3]

void casacore::MSHistoryHandler::cliCommand ( LogSinkInterface sink)

§ operator=()

MSHistoryHandler& casacore::MSHistoryHandler::operator= ( MSHistoryHandler other)

Member Data Documentation

§ application_p

String casacore::MSHistoryHandler::application_p
private

Definition at line 95 of file MSHistoryHandler.h.

§ histTable_p

MSHistory casacore::MSHistoryHandler::histTable_p
private

Definition at line 94 of file MSHistoryHandler.h.

§ msHistCol_p

MSHistoryColumns* casacore::MSHistoryHandler::msHistCol_p
private

Definition at line 93 of file MSHistoryHandler.h.


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