A class to enumerate a single Band, or a set of Bands. More...

#include <carma/szautil/CorrelatorBand.h>

Public Types
enum	Id { BANDNONE = 0x0, BAND0 = 0x1, BAND1 = 0x2, BAND2 = 0x4, BAND3 = 0x8, BAND4 = 0x10, BAND5 = 0x20, BAND6 = 0x40, BAND7 = 0x80, BAND8 = 0x100, BAND9 = 0x200, BAND10 = 0x400, BAND11 = 0x800, BAND12 = 0x1000, BAND13 = 0x2000, BAND14 = 0x4000, BAND15 = 0x8000, BANDMAX = BAND15, BANDALL = 0xFFFF }
	Enumerate known bands. More...

Public Member Functions
std::string	bandName ()
	Return string representing this band. More...

	CorrelatorBand (Id id)
	Constructor with Band enumerator. More...

	CorrelatorBand (unsigned int)
	Constructor with Band number as int. More...

	CorrelatorBand ()
	Constructor with uninitialized band. More...

	CorrelatorBand (const CorrelatorBand &band)
	Copy constructor. More...

unsigned int	getBandMax ()
	Return the maximum number of bands we know about. More...

unsigned short	getDcBandIndex ()
	Return an integer band index suitable for passing to the downconverter API. More...

unsigned short	getDcNodeIndex ()

unsigned int	getIntId ()
	Return an integer band index associated with this enumerator. More...

bool	isSet (CorrelatorBand::Id id)
	Return true if the passed is is part of this object's band set. More...

bool	isSet (CorrelatorBand &band)
	Return true if the passed is is part of this object's band set. More...

bool	isValidSingleBand ()
	Check if this object specifies a valid single band. More...

const CorrelatorBand	operator+ (const CorrelatorBand &band)
	Add two band enumerators. More...

const CorrelatorBand &	operator++ ()
	Prefix increment. More...

const CorrelatorBand	operator++ (int)
	Postfix increment. More...

bool	operator< (const CorrelatorBand band)
	Define < for two band enumerators. More...

bool	operator<= (const CorrelatorBand band)
	Define <= for two band enumerators. More...

bool	operator== (const CorrelatorBand band)
	Define equality for two band enumerators. More...

bool	operator> (const CorrelatorBand band)
	Define > for two band enumerators. More...

bool	operator>= (const CorrelatorBand band)
	Define >= for two band enumerators. More...

void	setId (CorrelatorBand::Id id)
	Set the id of this antenna enumerator. More...

Static Public Member Functions
static std::string	bandName (unsigned iBand)

static Frequency	bandWidth ()
	...................................................................... More...

static Frequency	bandWidthPerChannel ()
	...................................................................... More...

Public Attributes
enum sza::util::CorrelatorBand::Id	id_

Static Public Attributes
static const unsigned int	NBAND = 16

static const unsigned int	NCHAN_TOTAL = 17

Friends
CorrelatorBand::Id	operator+ (const CorrelatorBand::Id id1, const CorrelatorBand::Id id2)
	Allows expressions like BAND0+BAND1. More...

std::ostream &	operator<< (std::ostream &os, const CorrelatorBand &band)
	Allows cout << band. More...

std::ostringstream &	operator<< (std::ostringstream &os, const CorrelatorBand &band)
	Allows os << band. More...

Detailed Description

A class to enumerate a single Band, or a set of Bands.

Definition at line 24 of file CorrelatorBand.h.

Member Enumeration Documentation

enum sza::util::CorrelatorBand::Id

Enumerate known bands.

Definition at line 45 of file CorrelatorBand.h.

Constructor & Destructor Documentation

sza::util::CorrelatorBand::CorrelatorBand ( Id id )

Constructor with Band enumerator.

sza::util::CorrelatorBand::CorrelatorBand ( unsigned int )

Constructor with Band number as int.

Exceptions

Exception

sza::util::CorrelatorBand::CorrelatorBand ( )

Constructor with uninitialized band.

sza::util::CorrelatorBand::CorrelatorBand ( const CorrelatorBand & band )

Copy constructor.

Exceptions

Exception

Member Function Documentation

std::string sza::util::CorrelatorBand::bandName ( )

Return string representing this band.

static Frequency sza::util::CorrelatorBand::bandWidth ( )

static

......................................................................

Return the bandwidth

static Frequency sza::util::CorrelatorBand::bandWidthPerChannel ( )

static

......................................................................

Return the bandwidth per channel

unsigned int sza::util::CorrelatorBand::getBandMax ( )

Return the maximum number of bands we know about.

unsigned short sza::util::CorrelatorBand::getDcBandIndex ( )

Return an integer band index suitable for passing to the downconverter API.

unsigned int sza::util::CorrelatorBand::getIntId ( )

Return an integer band index associated with this enumerator.

Exceptions

Exception if this enumerator does not represent a single valid band.

bool sza::util::CorrelatorBand::isSet ( CorrelatorBand::Id id )

Return true if the passed is is part of this object's band set.

bool sza::util::CorrelatorBand::isSet ( CorrelatorBand & band )

Return true if the passed is is part of this object's band set.

bool sza::util::CorrelatorBand::isValidSingleBand ( )

Check if this object specifies a valid single band.

const CorrelatorBand sza::util::CorrelatorBand::operator+ ( const CorrelatorBand & band )

Add two band enumerators.

const CorrelatorBand& sza::util::CorrelatorBand::operator++ ( )

Prefix increment.

const CorrelatorBand sza::util::CorrelatorBand::operator++ ( int )

Postfix increment.

bool sza::util::CorrelatorBand::operator< ( const CorrelatorBand band )

Define < for two band enumerators.

bool sza::util::CorrelatorBand::operator<= ( const CorrelatorBand band )

Define <= for two band enumerators.

bool sza::util::CorrelatorBand::operator== ( const CorrelatorBand band )

Define equality for two band enumerators.

bool sza::util::CorrelatorBand::operator> ( const CorrelatorBand band )

Define > for two band enumerators.

bool sza::util::CorrelatorBand::operator>= ( const CorrelatorBand band )

Define >= for two band enumerators.

void sza::util::CorrelatorBand::setId ( CorrelatorBand::Id id )

Set the id of this antenna enumerator.

Friends And Related Function Documentation

CorrelatorBand::Id operator+	(	const CorrelatorBand::Id	id1,
		const CorrelatorBand::Id	id2
	)

friend

Allows expressions like BAND0+BAND1.

std::ostream& operator<<	(	std::ostream &	os,
		const CorrelatorBand &	band
	)

friend

Allows cout << band.

std::ostringstream& operator<<	(	std::ostringstream &	os,
		const CorrelatorBand &	band
	)

friend

Allows os << band.

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

carma/szautil/CorrelatorBand.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation