code::GeneralSRVFormatter Class Reference

Inheritance diagram for code::GeneralSRVFormatter:

List of all members.

---

Detailed Description

Create a RadialSet according to storm relative motion parameters and velocity data.

Author:

Lulin Song

Version:

Id

code_GeneralSRVFormatter.h,v 1.4 2009/06/02 20:17:39 lakshman Exp

Public Member Functions
virtual SmartPtr< DataType >	createDataObject (const std::vector< std::string > &data_param, const Index *) const
	Create a RadialSet from a vector of buffers which have velocity information and storm movement information.
virtual Buffer	createBuffer (const DataType &) const
	Not implemented.
	~GeneralSRVFormatter ()
virtual SmartPtr< DataType >	createDataObject (const Buffer &buf) const
	Given a buffer of the information in the right format, will convert it into a Data object.
virtual SmartPtr< DataType >	createDataObject (const Buffer &buf, const Index *) const
	Create a DataType given both a Buffer and an Index to use to extract other Records.
virtual SmartPtr< DataType >	createDataObject (const std::vector< Buffer > &bufs) const
	In some cases, it is necessary to pass in a multitude of variable-length buffers.
virtual SmartPtr< DataType >	createDataObject (const std::vector< Buffer > &bufs, const Index *index) const
	The more general purpose way of creating an object.
virtual void	getBuffersToBuild (std::vector< std::string > &buffers) const
	The Formatter can tell the Builder what buffers (files) it needs.
Static Public Member Functions
static void	introduceSelf ()
static bool	stormMotionAdjust (SmartPtr< DataType > radialset_adjustme, SmartPtr< DataType > data_table_with_speed_and_direction_columns)
	stormMotionAdjust on the radial set passed in.
static SmartPtr< Formatter >	getFormatter (const std::string &sourceType, const std::string &dataType)
	Given the source and data type, returns the appropriate formatter.
Protected Member Functions
	GeneralSRVFormatter ()
	Uses getFormatter() to get this class.
Static Protected Member Functions
static void	introduce (const std::string &sourceType, const std::string &dataType, SmartPtr< Formatter > new_subclass)
	Use this to introduce new formatters into the system.

---

Constructor & Destructor Documentation

code::GeneralSRVFormatter::~GeneralSRVFormatter

(

)

[inline]

code::GeneralSRVFormatter::GeneralSRVFormatter

(

)

[inline, protected]

Uses getFormatter() to get this class.

---

Member Function Documentation

virtual Buffer code::GeneralSRVFormatter::createBuffer

(

const DataType &

)

const [virtual]

Not implemented.

Implements code::Formatter.

virtual SmartPtr<DataType> code::Formatter::createDataObject	(	const std::vector< Buffer > &	bufs,
		const Index *	index
	)			const [virtual, inherited]

The more general purpose way of creating an object.

virtual SmartPtr<DataType> code::Formatter::createDataObject

(

const std::vector< Buffer > &

bufs

)

const [virtual, inherited]

In some cases, it is necessary to pass in a multitude of variable-length buffers.

This function is not pure virtual since it is needed only for special cases. This is the version that Hires must use.

virtual SmartPtr<DataType> code::Formatter::createDataObject	(	const Buffer &	buf,
		const Index *
	)			const [virtual, inherited]

Create a DataType given both a Buffer and an Index to use to extract other Records.

virtual SmartPtr<DataType> code::Formatter::createDataObject

(

const Buffer &

buf

)

const [virtual, inherited]

Given a buffer of the information in the right format, will convert it into a Data object.

Accept return value into a SmartPtr

Bug in egcs prevents the use of DerivedSmartPtr in pure virtual functions. So, till then, return SmartPtr< DataType > and do a dynamic downcast.

Reimplemented in code::LTGFormatter, and code::XMLDataFormatter.

virtual SmartPtr<DataType> code::GeneralSRVFormatter::createDataObject	(	const std::vector< std::string > &	data_param,
		const Index *
	)			const [virtual]

Create a RadialSet from a vector of buffers which have velocity information and storm movement information.

Returns:

a pointer to RadialSet

Reimplemented from code::Formatter.

virtual void code::Formatter::getBuffersToBuild

(

std::vector< std::string > &

buffers

)

const [virtual, inherited]

The Formatter can tell the Builder what buffers (files) it needs.

Hires Formatters must do this.

static SmartPtr< Formatter > code::Formatter::getFormatter	(	const std::string &	sourceType,
		const std::string &	dataType
	)			[static, inherited]

Given the source and data type, returns the appropriate formatter.

For example, getFormatter("hires", "VIL") will return the VIL formatter for hires.

Returns:

invalid smart pointer on error.

static void code::Formatter::introduce	(	const std::string &	sourceType,
		const std::string &	dataType,
		SmartPtr< Formatter >	new_subclass
	)			[static, protected, inherited]

Use this to introduce new formatters into the system.

static void code::GeneralSRVFormatter::introduceSelf

(

)

[static]

static bool code::GeneralSRVFormatter::stormMotionAdjust	(	SmartPtr< DataType >	radialset_adjustme,
		SmartPtr< DataType >	data_table_with_speed_and_direction_columns
	)			[static]

stormMotionAdjust on the radial set passed in.

The speed and direction values for the call are taken from the speed and direction columns in row zero of the data table passed in.

---