casacore::MSHistoryHandler Class Reference

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

#include <MSHistoryHandler.h>

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

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

Private Member Functions
	MSHistoryHandler ()
	Prevent use of default constructor. More...

Private Attributes
MSHistoryColumns *	msHistCol_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 One of the methods is static and can be called on a MeasurementSet without constructing any MSHistoryHandler objects.

Definition at line 55 of file MSHistoryHandler.h.

Constructor & Destructor Documentation

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

Construct the history handler from an ms.

casacore::MSHistoryHandler::~MSHistoryHandler

(

)

Destructor.

casacore::MSHistoryHandler::MSHistoryHandler ( )

inlineprivate

Prevent use of default constructor.

Definition at line 92 of file MSHistoryHandler.h.

Member Function Documentation

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

static

Add a string message.

This method does not need construction...can be called explicitly it flushes the history table of the ms

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

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

It does not flush the table (the destructor will flush).

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

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

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

void casacore::MSHistoryHandler::cliCommand

(

const String &

cliComm

)

void casacore::MSHistoryHandler::cliCommand

(

LogIO &

cliComm

)

void casacore::MSHistoryHandler::cliCommand

(

LogSinkInterface &

sink

)

MSHistoryHandler& casacore::MSHistoryHandler::operator=

(

const MSHistoryHandler &

other

)

Member Data Documentation

String casacore::MSHistoryHandler::application_p

private

Definition at line 96 of file MSHistoryHandler.h.

MSHistory casacore::MSHistoryHandler::histTable_p

private

Definition at line 95 of file MSHistoryHandler.h.

MSHistoryColumns* casacore::MSHistoryHandler::msHistCol_p

private

Definition at line 94 of file MSHistoryHandler.h.

---

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

• casa/casacore/ms/MeasurementSets/MSHistoryHandler.h