code::VirtualVolume Class Reference

List of all members.

---

Detailed Description

Allows the creation of a virtual volume record in real-time.

Typical usage is to construct a VirtualVolume object and then keep calling the update() method. Each call to update() returns a montage record (except the very first call which has information corresponding to only one product).

Author:

Lakshman

Version:

Id

code_VirtualVolume.h,v 1.6 2009/06/02 20:17:40 lakshman Exp

Public Member Functions
	VirtualVolume (const std::string &volumeProductName)
	the volume product name e.g: ReflecVol should be mentioned so that the montage record can be named accordingly.
	VirtualVolume ()
	An invalid object, provided only for STL convenience.
virtual Index::Record	update (const Angle &currentElevation, const Index::Record &thisRec, const Time &volumeStartTime)
	creates and returns the montage record given record corresponding to the elevation product, the elevation angle it belongs to and the start time of the volume that it belongs to.
virtual	~VirtualVolume ()
Protected Types
typedef std::deque< ElevationInfo >	VirtualVolumeInfo
Protected Attributes
std::string	volProductName
VirtualVolumeInfo	v
Classes
struct	ElevationInfo
	Helps the implementation of VirtualVolume. More...

---

Member Typedef Documentation

typedef std::deque<ElevationInfo> code::VirtualVolume::VirtualVolumeInfo [protected]

---

Constructor & Destructor Documentation

code::VirtualVolume::VirtualVolume

(

const std::string &

volumeProductName

)

[inline]

the volume product name e.g: ReflecVol should be mentioned so that the montage record can be named accordingly.

code::VirtualVolume::VirtualVolume

(

)

[inline]

An invalid object, provided only for STL convenience.

virtual code::VirtualVolume::~VirtualVolume

(

)

[inline, virtual]

---

Member Function Documentation

virtual Index::Record code::VirtualVolume::update	(	const Angle &	currentElevation,
		const Index::Record &	thisRec,
		const Time &	volumeStartTime
	)			[virtual]

creates and returns the montage record given record corresponding to the elevation product, the elevation angle it belongs to and the start time of the volume that it belongs to.

It also updates the internal structure, so that a history of update() calls is maintained.

---

Member Data Documentation

VirtualVolumeInfo code::VirtualVolume::v [protected]

std::string code::VirtualVolume::volProductName [protected]

---