MSHistoryHandler.h

Classes

MSHistoryHandler -- A class to provide a simple interface to history writing (full description)

class MSHistoryHandler

Interface

Public Members
MSHistoryHandler(MeasurementSet& ms, String app="")
MSHistoryHandler &operator=(MSHistoryHandler &other)
~MSHistoryHandler()
static void addMessage(MeasurementSet& ms, String message, String app="", String cliComm="", String origin="")
void addMessage(String message, String cliComm="", String origin="")
void addMessage(LogIO& message, String cliComm="")
void addMessage(LogSinkInterface& sink, String cliComm="")
void cliCommand(String& cliComm)
void cliCommand(LogIO& cliComm)
void cliCommand(LogSinkInterface& sink)

Description

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.

Member Description

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

Construct the history handler from an ms

MSHistoryHandler &operator=(MSHistoryHandler &other)

~MSHistoryHandler()

Destructor

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

Add a string message

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

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)