asdm::ArrayTimeInterval Class Reference

#include <ArrayTimeInterval.h>

Collaboration diagram for asdm::ArrayTimeInterval:

Detailed Description

The ArrayTimeInterval class aggregates an instance of ArrayTime and an instance of Interval.

Instances of ArrayTimeInterval are used in many ASDM tables whose rows contain information relevant during a certain laps of time and starting at a given date.

Definition at line 54 of file ArrayTimeInterval.h.

Public Member Functions

ArrayTimeInterval ()

inline constructors

ArrayTimeInterval (ArrayTime start, Interval duration)

ArrayTimeInterval (double startInMJD, double durationInDays)

ArrayTimeInterval (long long startInNanoSeconds, long long durationInNanoSeconds)

ArrayTimeInterval (ArrayTime start)

ArrayTimeInterval (double startInMJD)

ArrayTimeInterval (long long startInNanoSeconds)

ArrayTimeInterval (IDLArrayTimeInterval t)

void setStart (ArrayTime start)

Inline setters.

void setStart (double start)

void setStart (long long start)

void setDuration (Interval duration)

void setDuration (long long nanoSeconds)

void setDuration (double days)

ArrayTime getStart () const

inline getters

double getStartInMJD () const

long long getStartInNanoSeconds () const

Interval getDuration () const

long long getDurationInNanoSeconds () const

double getDurationInDays () const

bool equals (ArrayTimeInterval ati)

inline checkers

bool overlaps (ArrayTimeInterval ati)

bool contains (ArrayTimeInterval ati)

bool contains (ArrayTime at)

bool operator== (ArrayTimeInterval &)

Operators.

bool operator!= (ArrayTimeInterval &)

const asdmIDLTypes::IDLArrayTimeInterval toIDLArrayTimeInterval () const

To IDL conversion.

void toBin (EndianOSStream &eoss)

Write the binary representation of this to a EndianOSStream.

Static Public Member Functions

static void toBin (const vector< ArrayTimeInterval > &arrayTimeInterval, EndianOSStream &eoss)

Write the binary representation of a vector of ArrayTime to a EndianOSStream.

static void toBin (const vector< vector< ArrayTimeInterval > > &arrayTimeInterval, EndianOSStream &eoss)

Write the binary representation of a vector of vector of ArrayTimeInterval to a EndianOSStream.

static void toBin (const vector< vector< vector< ArrayTimeInterval > > > &arrayTimeInterval, EndianOSStream &eoss)

Write the binary representation of a vector of vector of vector of ArrayTimeInterval to a EndianOSStream.

static ArrayTimeInterval fromBin (EndianISStream &eiss)

Read the binary representation of an ArrayTimeInterval from a EndianISStream and use the read value to set an ArrayTimeInterval.

static vector< ArrayTimeInterval > from1DBin (EndianISStream &eiss)

Read the binary representation of a vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of ArrayTimeInterval.

static vector< vector< ArrayTimeInterval > > from2DBin (EndianISStream &eiss)

Read the binary representation of a vector of vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of vector of ArrayTimeInterval.

static vector< vector< vector<
ArrayTimeInterval > > > from3DBin (EndianISStream &eiss)

Read the binary representation of a vector of vector of vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of vector of vector of ArrayTimeInterval.

Private Attributes

ArrayTime start

Interval duration

Friends

ostream & operator<< (ostream &, ArrayTimeInterval &)

Constructor & Destructor Documentation

asdm::ArrayTimeInterval::ArrayTimeInterval ( ) [inline]

inline constructors

Definition at line 177 of file ArrayTimeInterval.h.

asdm::ArrayTimeInterval::ArrayTimeInterval	(	ArrayTime	start,
		Interval	duration
	)			`[inline]`

Definition at line 178 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), asdm::Long::MAX_VALUE, and start.

asdm::ArrayTimeInterval::ArrayTimeInterval	(	double	startInMJD,
		double	durationInDays
	)			`[inline]`

Definition at line 183 of file ArrayTimeInterval.h.

asdm::ArrayTimeInterval::ArrayTimeInterval	(	long long	startInNanoSeconds,
		long long	durationInNanoSeconds
	)			`[inline]`

Definition at line 187 of file ArrayTimeInterval.h.

References duration, asdm::Long::MAX_VALUE, and start.

asdm::ArrayTimeInterval::ArrayTimeInterval ( ArrayTime start ) [inline]

Definition at line 193 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), asdm::Long::MAX_VALUE, and start.

asdm::ArrayTimeInterval::ArrayTimeInterval ( double startInMJD ) [inline]

Definition at line 198 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), asdm::Long::MAX_VALUE, and start.

asdm::ArrayTimeInterval::ArrayTimeInterval ( long long startInNanoSeconds ) [inline]

Definition at line 203 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), asdm::Long::MAX_VALUE, and start.

asdm::ArrayTimeInterval::ArrayTimeInterval ( IDLArrayTimeInterval t )

Member Function Documentation

void asdm::ArrayTimeInterval::setStart ( ArrayTime start ) [inline]

Inline setters.

Definition at line 209 of file ArrayTimeInterval.h.

References start.

void asdm::ArrayTimeInterval::setStart ( double start ) [inline]

Definition at line 213 of file ArrayTimeInterval.h.

void asdm::ArrayTimeInterval::setStart ( long long start ) [inline]

Definition at line 217 of file ArrayTimeInterval.h.

void asdm::ArrayTimeInterval::setDuration ( Interval duration ) [inline]

Definition at line 221 of file ArrayTimeInterval.h.

References duration.

void asdm::ArrayTimeInterval::setDuration ( long long nanoSeconds ) [inline]

Definition at line 230 of file ArrayTimeInterval.h.

void asdm::ArrayTimeInterval::setDuration ( double days ) [inline]

Definition at line 226 of file ArrayTimeInterval.h.

References asdm::ArrayTime::unitsInADay.

ArrayTime asdm::ArrayTimeInterval::getStart ( ) const [inline]

inline getters

Definition at line 235 of file ArrayTimeInterval.h.

References start.

Referenced by contains(), equals(), asdm::operator<<(), and overlaps().

double asdm::ArrayTimeInterval::getStartInMJD ( ) const [inline]

Definition at line 239 of file ArrayTimeInterval.h.

References asdm::ArrayTime::getMJD(), and start.

long long asdm::ArrayTimeInterval::getStartInNanoSeconds ( ) const [inline]

Definition at line 243 of file ArrayTimeInterval.h.

References asdm::Interval::get(), and start.

Interval asdm::ArrayTimeInterval::getDuration ( ) const [inline]

Definition at line 247 of file ArrayTimeInterval.h.

References duration.

Referenced by contains(), equals(), asdm::operator<<(), and overlaps().

long long asdm::ArrayTimeInterval::getDurationInNanoSeconds ( ) const [inline]

Definition at line 255 of file ArrayTimeInterval.h.

References duration, and asdm::Interval::get().

double asdm::ArrayTimeInterval::getDurationInDays ( ) const [inline]

Definition at line 251 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), and asdm::ArrayTime::unitsInADay.

bool asdm::ArrayTimeInterval::equals ( ArrayTimeInterval ati ) [inline]

inline checkers

Definition at line 260 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), getDuration(), getStart(), and start.

bool asdm::ArrayTimeInterval::overlaps ( ArrayTimeInterval ati ) [inline]

Definition at line 265 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), getDuration(), getStart(), and start.

bool asdm::ArrayTimeInterval::contains ( ArrayTimeInterval ati ) [inline]

Definition at line 277 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), getDuration(), getStart(), and start.

bool asdm::ArrayTimeInterval::contains ( ArrayTime at ) [inline]

Definition at line 287 of file ArrayTimeInterval.h.

References duration, asdm::Interval::get(), start, and casa::time.

bool asdm::ArrayTimeInterval::operator== ( ArrayTimeInterval & ) [inline]

Operators.

Definition at line 295 of file ArrayTimeInterval.h.

References duration, and start.

bool asdm::ArrayTimeInterval::operator!= ( ArrayTimeInterval & ) [inline]

Definition at line 299 of file ArrayTimeInterval.h.

References duration, and start.

const asdmIDLTypes::IDLArrayTimeInterval asdm::ArrayTimeInterval::toIDLArrayTimeInterval ( ) const

To IDL conversion.

void asdm::ArrayTimeInterval::toBin ( EndianOSStream & eoss )

Write the binary representation of this to a EndianOSStream.

static void asdm::ArrayTimeInterval::toBin	(	const vector< ArrayTimeInterval > &	arrayTimeInterval,
		EndianOSStream &	eoss
	)			`[static]`

Write the binary representation of a vector of ArrayTime to a EndianOSStream.

Parameters:

	arrayTimeInterval	the vector of ArrayTime to be written
	eoss	the EndianOSStream to be written to

static void asdm::ArrayTimeInterval::toBin	(	const vector< vector< ArrayTimeInterval > > &	arrayTimeInterval,
		EndianOSStream &	eoss
	)			`[static]`

Write the binary representation of a vector of vector of ArrayTimeInterval to a EndianOSStream.

Parameters:

	arrayTimeInterval	the vector of vector of ArrayTimeInterval to be written
	eoss	the EndianOSStream to be written to

static void asdm::ArrayTimeInterval::toBin	(	const vector< vector< vector< ArrayTimeInterval > > > &	arrayTimeInterval,
		EndianOSStream &	eoss
	)			`[static]`

Write the binary representation of a vector of vector of vector of ArrayTimeInterval to a EndianOSStream.

Parameters:

	arrayTimeInterval	the vector of vector of vector of ArrayTimeInterval to be written
	eoss	the EndianOSStream to be written to

static ArrayTimeInterval asdm::ArrayTimeInterval::fromBin ( EndianISStream & eiss ) [static]

Read the binary representation of an ArrayTimeInterval from a EndianISStream and use the read value to set an ArrayTimeInterval.

Parameters:

eiss

the EndianStream to be read

Returns:: an ArrayTimeInterval

static vector<ArrayTimeInterval> asdm::ArrayTimeInterval::from1DBin ( EndianISStream & eiss ) [static]

Read the binary representation of a vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of ArrayTimeInterval.

Parameters:

dis

the EndianISStream to be read

Returns:: a vector of ArrayTimeInterval

static vector<vector<ArrayTimeInterval> > asdm::ArrayTimeInterval::from2DBin ( EndianISStream & eiss ) [static]

Read the binary representation of a vector of vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of vector of ArrayTimeInterval.

Parameters:

eiis

the EndianISStream to be read

Returns:: a vector of vector of ArrayTimeInterval

static vector<vector<vector<ArrayTimeInterval> > > asdm::ArrayTimeInterval::from3DBin ( EndianISStream & eiss ) [static]

Read the binary representation of a vector of vector of vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of vector of vector of ArrayTimeInterval.

Parameters:

eiss

the EndianISStream to be read

Returns:: a vector of vector of vector of ArrayTimeInterval

Friends And Related Function Documentation

ostream& operator<<	(	ostream &	o,
		ArrayTimeInterval &	ati
	)			`[friend]`

Definition at line 303 of file ArrayTimeInterval.h.

Member Data Documentation

ArrayTime asdm::ArrayTimeInterval::start [private]

Definition at line 58 of file ArrayTimeInterval.h.

Referenced by ArrayTimeInterval(), contains(), equals(), getStart(), getStartInMJD(), getStartInNanoSeconds(), operator!=(), operator==(), overlaps(), and setStart().

Interval asdm::ArrayTimeInterval::duration [private]

Definition at line 59 of file ArrayTimeInterval.h.

Referenced by ArrayTimeInterval(), contains(), equals(), getDuration(), getDurationInDays(), getDurationInNanoSeconds(), operator!=(), operator==(), overlaps(), and setDuration().

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

alma/implement/ASDM/ArrayTimeInterval.h

Generated on Thu Aug 27 21:23:15 2009 for NRAOCASA by

1.5.1


Public Member Functions
	ArrayTimeInterval ()
	inline constructors
	ArrayTimeInterval (ArrayTime start, Interval duration)
	ArrayTimeInterval (double startInMJD, double durationInDays)
	ArrayTimeInterval (long long startInNanoSeconds, long long durationInNanoSeconds)
	ArrayTimeInterval (ArrayTime start)
	ArrayTimeInterval (double startInMJD)
	ArrayTimeInterval (long long startInNanoSeconds)
	ArrayTimeInterval (IDLArrayTimeInterval t)
void	setStart (ArrayTime start)
	Inline setters.
void	setStart (double start)
void	setStart (long long start)
void	setDuration (Interval duration)
void	setDuration (long long nanoSeconds)
void	setDuration (double days)
ArrayTime	getStart () const
	inline getters
double	getStartInMJD () const
long long	getStartInNanoSeconds () const
Interval	getDuration () const
long long	getDurationInNanoSeconds () const
double	getDurationInDays () const
bool	equals (ArrayTimeInterval ati)
	inline checkers
bool	overlaps (ArrayTimeInterval ati)
bool	contains (ArrayTimeInterval ati)
bool	contains (ArrayTime at)
bool	operator== (ArrayTimeInterval &)
	Operators.
bool	operator!= (ArrayTimeInterval &)
const asdmIDLTypes::IDLArrayTimeInterval	toIDLArrayTimeInterval () const
	To IDL conversion.
void	toBin (EndianOSStream &eoss)
	Write the binary representation of this to a EndianOSStream.
Static Public Member Functions
static void	toBin (const vector< ArrayTimeInterval > &arrayTimeInterval, EndianOSStream &eoss)
	Write the binary representation of a vector of ArrayTime to a EndianOSStream.
static void	toBin (const vector< vector< ArrayTimeInterval > > &arrayTimeInterval, EndianOSStream &eoss)
	Write the binary representation of a vector of vector of ArrayTimeInterval to a EndianOSStream.
static void	toBin (const vector< vector< vector< ArrayTimeInterval > > > &arrayTimeInterval, EndianOSStream &eoss)
	Write the binary representation of a vector of vector of vector of ArrayTimeInterval to a EndianOSStream.
static ArrayTimeInterval	fromBin (EndianISStream &eiss)
	Read the binary representation of an ArrayTimeInterval from a EndianISStream and use the read value to set an ArrayTimeInterval.
static vector< ArrayTimeInterval >	from1DBin (EndianISStream &eiss)
	Read the binary representation of a vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of ArrayTimeInterval.
static vector< vector< ArrayTimeInterval > >	from2DBin (EndianISStream &eiss)
	Read the binary representation of a vector of vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of vector of ArrayTimeInterval.
static vector< vector< vector< ArrayTimeInterval > > >	from3DBin (EndianISStream &eiss)
	Read the binary representation of a vector of vector of vector of ArrayTimeInterval from an EndianISStream and use the read value to set a vector of vector of vector of ArrayTimeInterval.
Private Attributes
ArrayTime	start
Interval	duration
Friends
ostream &	operator<< (ostream &, ArrayTimeInterval &)