casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Private Attributes | Static Private Attributes | Friends
asdm::ArrayTimeInterval Class Reference

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

#include <ArrayTimeInterval.h>

List of all members.

Public Member Functions

 ArrayTimeInterval ()
 Constructors.
 ArrayTimeInterval (ArrayTime start, Interval duration)
 ArrayTimeInterval (double startInMJD, double durationInDays)
 ArrayTimeInterval (int64_t startInNanoSeconds, int64_t durationInNanoSeconds)
 ArrayTimeInterval (ArrayTime start)
 ArrayTimeInterval (double startInMJD)
 ArrayTimeInterval (int64_t startInNanoSeconds)
 ArrayTimeInterval (IDLArrayTimeInterval t)
void setStart (ArrayTime start)
 Setters.
void setStart (double start)
void setStart (int64_t start)
void setDuration (Interval duration)
void setDuration (int64_t nanoSeconds)
void setDuration (double days)
ArrayTime getStart () const
 Getters.
ArrayTime getMidPoint () const
double getStartInMJD () const
int64_t getStartInNanoSeconds () const
Interval getDuration () const
int64_t getDurationInNanoSeconds () const
double getDurationInDays () const
bool equals (ArrayTimeInterval ati)
 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) const
 Write the binary representation of this to a EndianOSStream.
string toString () const
 Returns a string representation of this.
 ArrayTimeInterval ()
 Constructors.
 ArrayTimeInterval (ArrayTime start, Interval duration)
 ArrayTimeInterval (double startInMJD, double durationInDays)
 ArrayTimeInterval (int64_t startInNanoSeconds, int64_t durationInNanoSeconds)
 ArrayTimeInterval (ArrayTime start)
 ArrayTimeInterval (double startInMJD)
 ArrayTimeInterval (int64_t startInNanoSeconds)
 ArrayTimeInterval (IDLArrayTimeInterval t)
void setStart (ArrayTime start)
 Setters.
void setStart (double start)
void setStart (int64_t start)
void setDuration (Interval duration)
void setDuration (int64_t nanoSeconds)
void setDuration (double days)
ArrayTime getStart () const
 Getters.
ArrayTime getMidPoint () const
double getStartInMJD () const
int64_t getStartInNanoSeconds () const
Interval getDuration () const
int64_t getDurationInNanoSeconds () const
double getDurationInDays () const
bool equals (ArrayTimeInterval ati)
 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) const
 Write the binary representation of this to a EndianOSStream.
string toString () const
 Returns a string representation of this.

Static Public Member Functions

static void readStartTimeDurationInBin (bool b)
 Defines how the representation of an ArrayTimeInterval found in subsequent reads of a document containing table exported in binary must be interpreted.
static bool readStartTimeDurationInBin ()
 Returns a boolean value whose meaning is defined as follows: true <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (startTime, duration).
static void readStartTimeDurationInXML (bool b)
 Defines how the representation of an ArrayTimeInterval found in subsequent reads of a document containing table exported in XML must be interpreted.
static bool readStartTimeDurationInXML ()
 Returns a boolean value whose meaning is defined as follows: true <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (startTime, duration).
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 (EndianIStream &eis)
 Read the binary representation of an ArrayTimeInterval from a EndianIStream and use the read value to set an ArrayTimeInterval.
static vector< ArrayTimeIntervalfrom1DBin (EndianIStream &eis)
 Read the binary representation of a vector of ArrayTimeInterval from an EndianIStream and use the read value to set a vector of ArrayTimeInterval.
static vector< vector
< ArrayTimeInterval > > 
from2DBin (EndianIStream &eis)
 Read the binary representation of a vector of vector of ArrayTimeInterval from an EndianIStream and use the read value to set a vector of vector of ArrayTimeInterval.
static vector< vector< vector
< ArrayTimeInterval > > > 
from3DBin (EndianIStream &eis)
 Read the binary representation of a vector of vector of vector of ArrayTimeInterval from an EndianIStream and use the read value to set a vector of vector of vector of ArrayTimeInterval.
static void readStartTimeDurationInBin (bool b)
 Defines how the representation of an ArrayTimeInterval found in subsequent reads of a document containing table exported in binary must be interpreted.
static bool readStartTimeDurationInBin ()
 Returns a boolean value whose meaning is defined as follows: true <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (startTime, duration).
static void readStartTimeDurationInXML (bool b)
 Defines how the representation of an ArrayTimeInterval found in subsequent reads of a document containing table exported in XML must be interpreted.
static bool readStartTimeDurationInXML ()
 Returns a boolean value whose meaning is defined as follows: true <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (startTime, duration).
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 (EndianIStream &eis)
 Read the binary representation of an ArrayTimeInterval from a EndianIStream and use the read value to set an ArrayTimeInterval.
static vector< ArrayTimeIntervalfrom1DBin (EndianIStream &eis)
 Read the binary representation of a vector of ArrayTimeInterval from an EndianIStream and use the read value to set a vector of ArrayTimeInterval.
static vector< vector
< ArrayTimeInterval > > 
from2DBin (EndianIStream &eis)
 Read the binary representation of a vector of vector of ArrayTimeInterval from an EndianIStream and use the read value to set a vector of vector of ArrayTimeInterval.
static vector< vector< vector
< ArrayTimeInterval > > > 
from3DBin (EndianIStream &eis)
 Read the binary representation of a vector of vector of vector of ArrayTimeInterval from an EndianIStream and use the read value to set a vector of vector of vector of ArrayTimeInterval.

Private Attributes

ArrayTime start
Interval duration

Static Private Attributes

static bool readStartTimeDurationInBin_
static bool readStartTimeDurationInXML_

Friends

ostream & operator<< (ostream &, ArrayTimeInterval &)
istream & operator>> (istream &, ArrayTimeInterval &)
ostream & operator<< (ostream &, ArrayTimeInterval &)
istream & operator>> (istream &, 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 55 of file ArrayTimeInterval.h.


Constructor & Destructor Documentation

Constructors.

inline constructors

Definition at line 224 of file ArrayTimeInterval.h.

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

Definition at line 230 of file ArrayTimeInterval.h.

asdm::ArrayTimeInterval::ArrayTimeInterval ( int64_t  startInNanoSeconds,
int64_t  durationInNanoSeconds 
) [inline]

Definition at line 234 of file ArrayTimeInterval.h.

References duration, asdm::Long::MAX_VALUE, casa::min(), and start.

Definition at line 240 of file ArrayTimeInterval.h.

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

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

Definition at line 245 of file ArrayTimeInterval.h.

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

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

Definition at line 250 of file ArrayTimeInterval.h.

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

asdm::ArrayTimeInterval::ArrayTimeInterval ( IDLArrayTimeInterval  t)

Constructors.

asdm::ArrayTimeInterval::ArrayTimeInterval ( double  startInMJD,
double  durationInDays 
)
asdm::ArrayTimeInterval::ArrayTimeInterval ( int64_t  startInNanoSeconds,
int64_t  durationInNanoSeconds 
)
asdm::ArrayTimeInterval::ArrayTimeInterval ( int64_t  startInNanoSeconds)
asdm::ArrayTimeInterval::ArrayTimeInterval ( IDLArrayTimeInterval  t)

Member Function Documentation

Definition at line 328 of file ArrayTimeInterval.h.

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

Definition at line 338 of file ArrayTimeInterval.h.

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

Checkers.

inline checkers

Definition at line 311 of file ArrayTimeInterval.h.

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

Checkers.

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

Parameters:
disthe EndianIStream to be read
Returns:
a vector of ArrayTimeInterval

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

Parameters:
disthe EndianIStream to be read
Returns:
a vector of ArrayTimeInterval
static vector<vector<ArrayTimeInterval> > asdm::ArrayTimeInterval::from2DBin ( EndianIStream eis) [static]

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

Parameters:
eiisthe EndianIStream to be read
Returns:
a vector of vector of ArrayTimeInterval
static vector<vector<ArrayTimeInterval> > asdm::ArrayTimeInterval::from2DBin ( EndianIStream eis) [static]

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

Parameters:
eiisthe EndianIStream to be read
Returns:
a vector of vector of ArrayTimeInterval
static vector<vector<vector<ArrayTimeInterval> > > asdm::ArrayTimeInterval::from3DBin ( EndianIStream eis) [static]

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

Parameters:
eisthe EndianIStream to be read
Returns:
a vector of vector of vector of ArrayTimeInterval
static vector<vector<vector<ArrayTimeInterval> > > asdm::ArrayTimeInterval::from3DBin ( EndianIStream eis) [static]

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

Parameters:
eisthe EndianIStream to be read
Returns:
a vector of vector of vector of ArrayTimeInterval

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

Parameters:
eisthe EndianStream to be read
Returns:
an ArrayTimeInterval

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

Parameters:
eisthe EndianStream to be read
Returns:
an ArrayTimeInterval

Definition at line 298 of file ArrayTimeInterval.h.

References duration.

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

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

Definition at line 306 of file ArrayTimeInterval.h.

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

Definition at line 286 of file ArrayTimeInterval.h.

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

Getters.

inline getters

Definition at line 282 of file ArrayTimeInterval.h.

References start.

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

Getters.

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

Definition at line 290 of file ArrayTimeInterval.h.

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

Definition at line 294 of file ArrayTimeInterval.h.

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

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

Definition at line 350 of file ArrayTimeInterval.h.

References duration, and start.

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

Operators.

Definition at line 346 of file ArrayTimeInterval.h.

References duration, and start.

bool asdm::ArrayTimeInterval::operator== ( ArrayTimeInterval )

Operators.

Definition at line 316 of file ArrayTimeInterval.h.

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

static void asdm::ArrayTimeInterval::readStartTimeDurationInBin ( bool  b) [static]

Defines how the representation of an ArrayTimeInterval found in subsequent reads of a document containing table exported in binary must be interpreted.

The interpretation depends on the value of the argument b : b == true means that it must be interpreted as (startTime, duration) b == false means that it must be interpreted as (midPoint, duration)

Parameters:
ba boolean value.
static void asdm::ArrayTimeInterval::readStartTimeDurationInBin ( bool  b) [static]

Defines how the representation of an ArrayTimeInterval found in subsequent reads of a document containing table exported in binary must be interpreted.

The interpretation depends on the value of the argument b : b == true means that it must be interpreted as (startTime, duration) b == false means that it must be interpreted as (midPoint, duration)

Parameters:
ba boolean value.

Returns a boolean value whose meaning is defined as follows: true <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (startTime, duration).

false <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (midPoint, duration).

Returns a boolean value whose meaning is defined as follows: true <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (startTime, duration).

false <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (midPoint, duration).

static void asdm::ArrayTimeInterval::readStartTimeDurationInXML ( bool  b) [static]

Defines how the representation of an ArrayTimeInterval found in subsequent reads of a document containing table exported in XML must be interpreted.

The interpretation depends on the value of the argument b : b == true means that it must be interpreted as (startTime, duration) b == false means that it must be interpreted as (midPoint, duration)

Parameters:
ba boolean value.
static void asdm::ArrayTimeInterval::readStartTimeDurationInXML ( bool  b) [static]

Defines how the representation of an ArrayTimeInterval found in subsequent reads of a document containing table exported in XML must be interpreted.

The interpretation depends on the value of the argument b : b == true means that it must be interpreted as (startTime, duration) b == false means that it must be interpreted as (midPoint, duration)

Parameters:
ba boolean value.

Returns a boolean value whose meaning is defined as follows: true <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (startTime, duration).

false <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (midPoint, duration).

Returns a boolean value whose meaning is defined as follows: true <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (startTime, duration).

false <=> the representation of ArrayTimeInterval object found in any binary table will be considered as (midPoint, duration).

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

Definition at line 268 of file ArrayTimeInterval.h.

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

Definition at line 277 of file ArrayTimeInterval.h.

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

Definition at line 273 of file ArrayTimeInterval.h.

References asdm::ArrayTime::unitsInADay.

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

Setters.

Inline setters.

Definition at line 256 of file ArrayTimeInterval.h.

Setters.

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

Definition at line 260 of file ArrayTimeInterval.h.

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

Definition at line 264 of file ArrayTimeInterval.h.

Write the binary representation of this to a EndianOSStream.

It writes successively the midpoint , the duration.

Write the binary representation of this to a EndianOSStream.

It writes successively the midpoint , the duration.

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:
arrayTimeIntervalthe vector of ArrayTime to be written
eossthe EndianOSStream to be written to
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:
arrayTimeIntervalthe vector of ArrayTime to be written
eossthe 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:
arrayTimeIntervalthe vector of vector of ArrayTimeInterval to be written
eossthe 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:
arrayTimeIntervalthe vector of vector of ArrayTimeInterval to be written
eossthe 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:
arrayTimeIntervalthe vector of vector of vector of ArrayTimeInterval to be written
eossthe 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:
arrayTimeIntervalthe vector of vector of vector of ArrayTimeInterval to be written
eossthe EndianOSStream to be written to
const asdmIDLTypes::IDLArrayTimeInterval asdm::ArrayTimeInterval::toIDLArrayTimeInterval ( ) const

To IDL conversion.

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

To IDL conversion.

Returns a string representation of this.

Returns a string representation of this.


Friends And Related Function Documentation

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

Definition at line 354 of file ArrayTimeInterval.h.

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

Definition at line 354 of file ArrayTimeInterval.h.

istream& operator>> ( istream &  i,
ArrayTimeInterval ati 
) [friend]

Definition at line 359 of file ArrayTimeInterval.h.

istream& operator>> ( istream &  i,
ArrayTimeInterval ati 
) [friend]

Definition at line 359 of file ArrayTimeInterval.h.


Member Data Documentation

Definition at line 63 of file ArrayTimeInterval.h.

Definition at line 64 of file ArrayTimeInterval.h.


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