casacore::RFWriter Class Reference

Abstract superclass for any class that writes Regions to a region file format. More...

#include <RFReaderWriter.h>

Inheritance diagram for casacore::RFWriter:

Public Member Functions
	RFWriter ()
	Constructor.
virtual	~RFWriter ()
	Destructor.
virtual void	setOptions (const Record *options)
	Sets the optional to the values.
virtual bool	write (const Record &region) const =0
	Write the given regions to the filename set with setFile and returns true if no errors were reported, false otherwise.
virtual bool	writeFile (const String &filename, const Record &regions)
	Calls setFile then write.

Detailed Description

Abstract superclass for any class that writes Regions to a region file format.

Intended use:

Public interface

Synopsis

Provide a well defined set of operations that all region file writers must contain regardless of the file format of the file being saved. .

Note that some file formats allow for plotting options to be stored with the region information. The setOptions method allows the user to supply this information.

Example

Definition at line 283 of file RFReaderWriter.h.

Constructor & Destructor Documentation

casacore::RFWriter::RFWriter ( ) [inline]

Constructor.

Definition at line 287 of file RFReaderWriter.h.

virtual casacore::RFWriter::~RFWriter ( ) [inline, virtual]

Destructor.

Definition at line 290 of file RFReaderWriter.h.

Member Function Documentation

virtual void casacore::RFWriter::setOptions ( const Record * options ) [inline, virtual]

Sets the optional to the values.

These values are related to the drawing of regions and not defining the regions themselves. For example, the colour to draw the region as.

Reimplemented in casacore::AipsIOReaderWriter.

Definition at line 295 of file RFReaderWriter.h.

References casacore::Record::defineRecord(), and casacore::RFReaderWriter::options_p.

virtual bool casacore::RFWriter::write ( const Record & region ) const [pure virtual]

Write the given regions to the filename set with setFile and returns true if no errors were reported, false otherwise.

If false is returned, the details can be found using lastError().

Implemented in casacore::AipsIOReaderWriter.

Referenced by writeFile().

virtual bool casacore::RFWriter::writeFile	(	const String &	filename,
		const Record &	regions
	)			`[inline, virtual]`

Calls setFile then write.

Definition at line 306 of file RFReaderWriter.h.

References casacore::RFReaderWriter::setFile(), and write().

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

casacore/images/Regions/RFReaderWriter.h