casacore::MSHistoryHandler Class Reference

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

#include <MSHistoryHandler.h>

List of all members.

Public Member Functions
	MSHistoryHandler (MeasurementSet &ms, String app="")
	Construct the history handler from an ms.
MSHistoryHandler &	operator= (MSHistoryHandler &other)
	~MSHistoryHandler ()
	Destructor.
void	addMessage (String message, String cliComm="", String origin="")
	Add message and/or CLI command to the history table.
void	addMessage (LogIO &message, String cliComm="")
	In this version the LogIO object need to have a valid LogSink with messages in it.
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.
Private Member Functions
	MSHistoryHandler ()
	Prevent use of default constructor.
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 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

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

Construct the history handler from an ms.

casacore::MSHistoryHandler::~MSHistoryHandler

(

)

Destructor.

casacore::MSHistoryHandler::MSHistoryHandler

(

)

[inline, private]

Prevent use of default constructor.

Definition at line 91 of file MSHistoryHandler.h.

---

Member Function Documentation

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

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

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

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

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

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

void casacore::MSHistoryHandler::cliCommand

(

LogSinkInterface &

sink

)

void casacore::MSHistoryHandler::cliCommand

(

LogIO &

cliComm

)

void casacore::MSHistoryHandler::cliCommand

(

String &

cliComm

)

MSHistoryHandler& casacore::MSHistoryHandler::operator=

(

MSHistoryHandler &

other

)

---

Member Data Documentation

String casacore::MSHistoryHandler::application_p [private]

Definition at line 95 of file MSHistoryHandler.h.

MSHistory casacore::MSHistoryHandler::histTable_p [private]

Definition at line 94 of file MSHistoryHandler.h.

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:

• casacore/ms/MeasurementSets/MSHistoryHandler.h