casa::ImageHistory< T > Class Template Reference

#include <ImageHistory.h>

Public Member Functions
	ImageHistory ()=delete
	Top level interface accessing image history data. More...
	ImageHistory (const SPIIT image)
	~ImageHistory ()
	destructor More...
void	addHistory (const casacore::String &origin, const casacore::String &history)
	add a line to the history More...
void	addHistory (const casacore::LogOrigin &origin, const casacore::String &history)
void	addHistory (const casacore::String &origin, const std::vector< casacore::String > &history)
	add multiple history lines, all which have the same origin More...
void	addHistory (const casacore::LogOrigin &origin, const std::vector< casacore::String > &history)
void	addHistory (const casacore::String &origin, const std::vector< string > &history)
void	addHistory (const std::vector< std::pair< casacore::LogOrigin, casacore::String > > &history)
void	addHistory (const std::vector< std::pair< casacore::String, casacore::String >> &history)
void	clear ()
	erase all messages. More...
std::vector< casacore::String >	get (casacore::Bool list) const
std::vector< string >	getAsStdStrings (casacore::Bool list) const
template<class U >
void	append (SPCIIU image)
	Append the specified image's history to this image's history. More...
template<class U >
void	append (SPIIU image)
casacore::String	getClass () const
casacore::LogIO &	getLogSink ()

Static Public Member Functions
static std::vector< std::pair < casacore::String, casacore::String > >	getApplicationHistory (const casacore::LogOrigin &origin, const casacore::String &taskname, const vector< casacore::String > &paramNames, const vector< casac::variant > &paramValues, const casacore::String &imageName)
	return a vector<String> containing a formatted application summary. More...

Private Attributes
const SPIIT	_image

Detailed Description

template<class T>
class casa::ImageHistory< T >

Definition at line 16 of file ImageHistory.h.

Constructor & Destructor Documentation

template<class T >

casa::ImageHistory< T >::ImageHistory ( )

delete

Top level interface accessing image history data.

Etymology

Image History access

Synopsis

Top level interface for accessing image history.

template<class T >

casa::ImageHistory< T >::ImageHistory

(

const SPIIT

image

)

template<class T >

casa::ImageHistory< T >::~ImageHistory ( )

inline

destructor

Definition at line 42 of file ImageHistory.h.

Member Function Documentation

template<class T >

void casa::ImageHistory< T >::addHistory	(	const casacore::String &	origin,
		const casacore::String &	history
	)

add a line to the history

template<class T >

void casa::ImageHistory< T >::addHistory	(	const casacore::LogOrigin &	origin,
		const casacore::String &	history
	)

template<class T >

void casa::ImageHistory< T >::addHistory	(	const casacore::String &	origin,
		const std::vector< casacore::String > &	history
	)

add multiple history lines, all which have the same origin

template<class T >

void casa::ImageHistory< T >::addHistory	(	const casacore::LogOrigin &	origin,
		const std::vector< casacore::String > &	history
	)

template<class T >

void casa::ImageHistory< T >::addHistory	(	const casacore::String &	origin,
		const std::vector< string > &	history
	)

template<class T >

void casa::ImageHistory< T >::addHistory

(

const std::vector< std::pair< casacore::LogOrigin, casacore::String > > &

history

)

template<class T >

void casa::ImageHistory< T >::addHistory

(

const std::vector< std::pair< casacore::String, casacore::String >> &

history

)

template<class T >

template<class U >

void casa::ImageHistory< T >::append

(

SPCIIU

image

)

Append the specified image's history to this image's history.

template<class T >

template<class U >

void casa::ImageHistory< T >::append

(

SPIIU

image

)

template<class T >

void casa::ImageHistory< T >::clear

(

)

erase all messages.

Cannot be undone!

template<class T >

std::vector<casacore::String> casa::ImageHistory< T >::get

(

casacore::Bool

list

)

const

template<class T >

static std::vector<std::pair<casacore::String, casacore::String> > casa::ImageHistory< T >::getApplicationHistory ( const casacore::LogOrigin &  origin, const casacore::String &  taskname, const vector< casacore::String > &  paramNames, const vector< casac::variant > &  paramValues, const casacore::String &  imageName  )

static

return a vector<String> containing a formatted application summary.

Nothing is written to them image that is useful for history writing.

template<class T >

std::vector<string> casa::ImageHistory< T >::getAsStdStrings

(

casacore::Bool

list

)

const

template<class T >

casacore::String casa::ImageHistory< T >::getClass ( ) const

inline

Definition at line 99 of file ImageHistory.h.

template<class T >

casacore::LogIO& casa::ImageHistory< T >::getLogSink

(

)

Member Data Documentation

template<class T >

const SPIIT casa::ImageHistory< T >::_image

private

Definition at line 105 of file ImageHistory.h.

---

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

• casa/code/imageanalysis/ImageAnalysis/ImageHistory.h