asdm::MainRow Class Reference

The MainRow class is a row of a MainTable. More...

#include <MainRow.h>

Public Member Functions
virtual	~MainRow ()
	friend class asdm::TableStreamReader<MainTable, MainRow>;
MainTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
void	setTime (ArrayTime time)
	Set time with the specified ArrayTime.
int	getNumAntenna () const
	===> Attribute numAntenna
void	setNumAntenna (int numAntenna)
	Set numAntenna with the specified int.
TimeSamplingMod::TimeSampling	getTimeSampling () const
	===> Attribute timeSampling
void	setTimeSampling (TimeSamplingMod::TimeSampling timeSampling)
	Set timeSampling with the specified TimeSamplingMod::TimeSampling.
Interval	getInterval () const
	===> Attribute interval
void	setInterval (Interval interval)
	Set interval with the specified Interval.
int	getNumIntegration () const
	===> Attribute numIntegration
void	setNumIntegration (int numIntegration)
	Set numIntegration with the specified int.
int	getScanNumber () const
	===> Attribute scanNumber
void	setScanNumber (int scanNumber)
	Set scanNumber with the specified int.
int	getSubscanNumber () const
	===> Attribute subscanNumber
void	setSubscanNumber (int subscanNumber)
	Set subscanNumber with the specified int.
int64_t	getDataSize () const
	===> Attribute dataSize
void	setDataSize (int64_t dataSize)
	Set dataSize with the specified int64_t.
EntityRef	getDataUID () const
	===> Attribute dataUID
void	setDataUID (EntityRef dataUID)
	Set dataUID with the specified EntityRef.
void	setConfigDescriptionId (Tag configDescriptionId)
	Set configDescriptionId with the specified Tag.
Tag	getExecBlockId () const
	===> Attribute execBlockId
void	setExecBlockId (Tag execBlockId)
	Set execBlockId with the specified Tag.
Tag	getFieldId () const
	===> Attribute fieldId
void	setFieldId (Tag fieldId)
	Set fieldId with the specified Tag.
vector< Tag >	getStateId () const
	===> Attribute stateId
void	setStateId (vector< Tag > stateId)
	Set stateId with the specified vector<Tag> .
Links ConfigDescriptionRow	getConfigDescriptionUsingConfigDescriptionId ()
	configDescriptionId pointer to the row in the ConfigDescription table having ConfigDescription.configDescriptionId == configDescriptionId
FieldRow *	getFieldUsingFieldId ()
	fieldId pointer to the row in the Field table having Field.fieldId == fieldId
void	setStateId (int i, Tag stateId)
	Set stateId[i] with the specified Tag.
void	addStateId (Tag id)
	Append a Tag to stateId.
void	addStateId (const vector< Tag > &id)
	Append a vector of Tag to stateId.
const Tag	getStateId (int i)
	Returns the Tag stored in stateId at position i.
StateRow *	getStateUsingStateId (int i)
	Returns the StateRow linked to this row via the tag stored in stateId at position i.
vector< StateRow * >	getStatesUsingStateId ()
	Returns the vector of StateRow* linked to this row via the Tags stored in stateId.
ExecBlockRow *	getExecBlockUsingExecBlockId ()
	execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId
bool	compareNoAutoInc (ArrayTime time, Tag configDescriptionId, Tag fieldId, int numAntenna, TimeSamplingMod::TimeSampling timeSampling, Interval interval, int numIntegration, int scanNumber, int subscanNumber, int64_t dataSize, EntityRef dataUID, vector< Tag > stateId, Tag execBlockId)
	Compare each mandatory attribute except the autoincrementable one of this MainRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (int numAntenna, TimeSamplingMod::TimeSampling timeSampling, Interval interval, int numIntegration, int scanNumber, int subscanNumber, int64_t dataSize, EntityRef dataUID, vector< Tag > stateId, Tag execBlockId)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (MainRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::MainRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::MainRowIDL &x) const
	Define the content of a MainRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::MainRowIDL x)
	Fill the values of this row from the IDL struct MainRowIDL.
std::string	toXML () const
	Return this row in the form of an XML string.
void	setFromXML (std::string rowDoc)
	Fill the values of this row from an XML string that was produced by the toXML() method.
Public Attributes
Intrinsic Table	Attributes
Extrinsic Table	Attributes
Private Member Functions
void	isAdded (bool added)
	This method is used by the Table class when this row is added to the table.
	MainRow (MainTable &table)
	Create a MainRow.
	MainRow (MainTable &table, MainRow &row)
	Create a MainRow using a copy constructor mechanism.
void	timeFromBin (EndianIStream &eis)
void	configDescriptionIdFromBin (EndianIStream &eis)
void	fieldIdFromBin (EndianIStream &eis)
void	numAntennaFromBin (EndianIStream &eis)
void	timeSamplingFromBin (EndianIStream &eis)
void	intervalFromBin (EndianIStream &eis)
void	numIntegrationFromBin (EndianIStream &eis)
void	scanNumberFromBin (EndianIStream &eis)
void	subscanNumberFromBin (EndianIStream &eis)
void	dataSizeFromBin (EndianIStream &eis)
void	dataUIDFromBin (EndianIStream &eis)
void	stateIdFromBin (EndianIStream &eis)
void	execBlockIdFromBin (EndianIStream &eis)
void	timeFromText (const string &s)
void	configDescriptionIdFromText (const string &s)
void	fieldIdFromText (const string &s)
void	numAntennaFromText (const string &s)
void	timeSamplingFromText (const string &s)
void	intervalFromText (const string &s)
void	numIntegrationFromText (const string &s)
void	scanNumberFromText (const string &s)
void	subscanNumberFromText (const string &s)
void	dataSizeFromText (const string &s)
void	stateIdFromText (const string &s)
void	execBlockIdFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
MainTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
int	numAntenna
	===> Attribute numAntenna
TimeSamplingMod::TimeSampling	timeSampling
	===> Attribute timeSampling
Interval	interval
	===> Attribute interval
int	numIntegration
	===> Attribute numIntegration
int	scanNumber
	===> Attribute scanNumber
int	subscanNumber
	===> Attribute subscanNumber
int64_t	dataSize
	===> Attribute dataSize
EntityRef	dataUID
	===> Attribute dataUID
Tag	execBlockId
	===> Attribute execBlockId
Tag	fieldId
	===> Attribute fieldId
vector< Tag >	stateId
	===> Attribute stateId
Links *binary deserialization material from an EndianIStream std::map< std::string, MainAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, MainAttributeFromText >	fromTextMethods
Friends
class	asdm::MainTable
class	asdm::RowTransformer< MainRow >

Detailed Description

The MainRow class is a row of a MainTable.

Generated from model's revision "1.64", branch "HEAD"

Definition at line 132 of file MainRow.h.

Constructor & Destructor Documentation

virtual asdm::MainRow::~MainRow ( ) [virtual]

friend class asdm::TableStreamReader<MainTable, MainRow>;

asdm::MainRow::MainRow ( MainTable & table ) [private]

Create a MainRow.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters:

table

The table to which this row belongs.

asdm::MainRow::MainRow	(	MainTable &	table,
		MainRow &	row
	)			`[private]`

Create a MainRow using a copy constructor mechanism.

Given a MainRow row and a MainTable table, the method creates a new MainRow owned by table. Each attribute of the created row is a copy (deep) of the corresponding attribute of row. The method does not add the created row to its table, its simply parents it to table, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes). If row is null then the method returns a row with default values for its attributes.

This constructor is private because only the table can create rows. All rows know the table to which they belong.

Parameters:

	table	The table to which this row belongs.
	row	The row which is to be copied.

Member Function Documentation

void asdm::MainRow::addStateId ( const vector< Tag > & id )

Append a vector of Tag to stateId.

Parameters:

id

an array of Tag to be appended to stateId

void asdm::MainRow::addStateId ( Tag id )

Append a Tag to stateId.

Parameters:

id

the Tag to be appended to stateId

bool asdm::MainRow::compareNoAutoInc	(	ArrayTime	time,
		Tag	configDescriptionId,
		Tag	fieldId,
		int	numAntenna,
		TimeSamplingMod::TimeSampling	timeSampling,
		Interval	interval,
		int	numIntegration,
		int	scanNumber,
		int	subscanNumber,
		int64_t	dataSize,
		EntityRef	dataUID,
		vector< Tag >	stateId,
		Tag	execBlockId
	)

Compare each mandatory attribute except the autoincrementable one of this MainRow with the corresponding parameters and return true if there is a match and false otherwise.

Parameters:

	time
	configDescriptionId
	fieldId
	numAntenna
	timeSampling
	interval
	numIntegration
	scanNumber
	subscanNumber
	dataSize
	dataUID
	stateId
	execBlockId

bool asdm::MainRow::compareRequiredValue	(	int	numAntenna,
		TimeSamplingMod::TimeSampling	timeSampling,
		Interval	interval,
		int	numIntegration,
		int	scanNumber,
		int	subscanNumber,
		int64_t	dataSize,
		EntityRef	dataUID,
		vector< Tag >	stateId,
		Tag	execBlockId
	)

Compare each mandatory value (i.e.

not in the key) attribute with the corresponding parameters and return true if there is a match and false otherwise.

Parameters:

	numAntenna
	timeSampling
	interval
	numIntegration
	scanNumber
	subscanNumber
	dataSize
	dataUID
	stateId
	execBlockId

void asdm::MainRow::configDescriptionIdFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::configDescriptionIdFromText ( const string & s ) [private]

void asdm::MainRow::dataSizeFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::dataSizeFromText ( const string & s ) [private]

void asdm::MainRow::dataUIDFromBin ( EndianIStream & eis ) [private]

bool asdm::MainRow::equalByRequiredValue ( MainRow * x )

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Parameters:

x

a pointer on the MainRow whose required attributes of the value part will be compared with those of this.

Returns:: a boolean.

void asdm::MainRow::execBlockIdFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::execBlockIdFromText ( const string & s ) [private]

void asdm::MainRow::fieldIdFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::fieldIdFromText ( const string & s ) [private]

Links* ConfigDescriptionRow* asdm::MainRow::getConfigDescriptionUsingConfigDescriptionId ( )

configDescriptionId pointer to the row in the ConfigDescription table having ConfigDescription.configDescriptionId == configDescriptionId

Returns:: a ConfigDescriptionRow*

int64_t asdm::MainRow::getDataSize ( ) const

===> Attribute dataSize

Get dataSize.

Returns:: dataSize as int64_t

EntityRef asdm::MainRow::getDataUID ( ) const

===> Attribute dataUID

Get dataUID.

Returns:: dataUID as EntityRef

Tag asdm::MainRow::getExecBlockId ( ) const

===> Attribute execBlockId

Get execBlockId.

Returns:: execBlockId as Tag

ExecBlockRow* asdm::MainRow::getExecBlockUsingExecBlockId ( )

execBlockId pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId

Returns:: a ExecBlockRow*

Tag asdm::MainRow::getFieldId ( ) const

===> Attribute fieldId

Get fieldId.

Returns:: fieldId as Tag

FieldRow* asdm::MainRow::getFieldUsingFieldId ( )

fieldId pointer to the row in the Field table having Field.fieldId == fieldId

Returns:: a FieldRow*

Interval asdm::MainRow::getInterval ( ) const

===> Attribute interval

Get interval.

Returns:: interval as Interval

int asdm::MainRow::getNumAntenna ( ) const

===> Attribute numAntenna

Get numAntenna.

Returns:: numAntenna as int

int asdm::MainRow::getNumIntegration ( ) const

===> Attribute numIntegration

Get numIntegration.

Returns:: numIntegration as int

int asdm::MainRow::getScanNumber ( ) const

===> Attribute scanNumber

Get scanNumber.

Returns:: scanNumber as int

const Tag asdm::MainRow::getStateId ( int i )

Returns the Tag stored in stateId at position i.

Parameters:

i

the position in stateId where the Tag is retrieved.

Returns:: the Tag stored at position i in stateId.

vector<Tag> asdm::MainRow::getStateId ( ) const

===> Attribute stateId

Get stateId.

Returns:: stateId as vector<Tag>

vector<StateRow *> asdm::MainRow::getStatesUsingStateId ( )

Returns the vector of StateRow* linked to this row via the Tags stored in stateId.

Returns:: an array of pointers on StateRow.

StateRow* asdm::MainRow::getStateUsingStateId ( int i )

Returns the StateRow linked to this row via the tag stored in stateId at position i.

Parameters:

i

the position in stateId.

Returns:: a pointer on a StateRow whose key (a Tag) is equal to the Tag stored at position i in the stateId.

int asdm::MainRow::getSubscanNumber ( ) const

===> Attribute subscanNumber

Get subscanNumber.

Returns:: subscanNumber as int

MainTable& asdm::MainRow::getTable ( ) const

Return the table to which this row belongs.

TimeSamplingMod::TimeSampling asdm::MainRow::getTimeSampling ( ) const

===> Attribute timeSampling

Get timeSampling.

Returns:: timeSampling as TimeSamplingMod::TimeSampling

void asdm::MainRow::intervalFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::intervalFromText ( const string & s ) [private]

void asdm::MainRow::isAdded ( bool added ) [private]

This method is used by the Table class when this row is added to the table.

bool asdm::MainRow::isAdded ( ) const

Has this row been added to its table ?

Returns:: true if and only if it has been added.

void asdm::MainRow::numAntennaFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::numAntennaFromText ( const string & s ) [private]

void asdm::MainRow::numIntegrationFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::numIntegrationFromText ( const string & s ) [private]

void asdm::MainRow::scanNumberFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::scanNumberFromText ( const string & s ) [private]

void asdm::MainRow::setConfigDescriptionId ( Tag configDescriptionId )

Set configDescriptionId with the specified Tag.

Parameters:

configDescriptionId

The Tag value to which configDescriptionId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

void asdm::MainRow::setDataSize ( int64_t dataSize )

Set dataSize with the specified int64_t.

Parameters:

dataSize

The int64_t value to which dataSize is to be set.

void asdm::MainRow::setDataUID ( EntityRef dataUID )

Set dataUID with the specified EntityRef.

Parameters:

dataUID

The EntityRef value to which dataUID is to be set.

void asdm::MainRow::setExecBlockId ( Tag execBlockId )

Set execBlockId with the specified Tag.

Parameters:

execBlockId

The Tag value to which execBlockId is to be set.

void asdm::MainRow::setFieldId ( Tag fieldId )

Set fieldId with the specified Tag.

Parameters:

fieldId

The Tag value to which fieldId is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

void asdm::MainRow::setFromIDL ( asdmIDL::MainRowIDL x )

Fill the values of this row from the IDL struct MainRowIDL.

Parameters:

x

The IDL struct containing the values used to fill this row.

Exceptions:

ConversionException

void asdm::MainRow::setFromXML ( std::string rowDoc )

Fill the values of this row from an XML string that was produced by the toXML() method.

Parameters:

rowDoc

the XML string being used to set the values of this row.

Exceptions:

ConversionException

void asdm::MainRow::setInterval ( Interval interval )

Set interval with the specified Interval.

Parameters:

interval

The Interval value to which interval is to be set.

void asdm::MainRow::setNumAntenna ( int numAntenna )

Set numAntenna with the specified int.

Parameters:

numAntenna

The int value to which numAntenna is to be set.

void asdm::MainRow::setNumIntegration ( int numIntegration )

Set numIntegration with the specified int.

Parameters:

numIntegration

The int value to which numIntegration is to be set.

void asdm::MainRow::setScanNumber ( int scanNumber )

Set scanNumber with the specified int.

Parameters:

scanNumber

The int value to which scanNumber is to be set.

void asdm::MainRow::setStateId	(	int	i,
		Tag	stateId
	)

Set stateId[i] with the specified Tag.

Parameters:

	i	The index in stateId where to set the Tag value.
	stateId	The Tag value to which stateId[i] is to be set.

Exceptions:

IndexOutOfBoundsException

void asdm::MainRow::setStateId ( vector< Tag > stateId )

Set stateId with the specified vector<Tag> .

Parameters:

stateId

The vector<Tag> value to which stateId is to be set.

void asdm::MainRow::setSubscanNumber ( int subscanNumber )

Set subscanNumber with the specified int.

Parameters:

subscanNumber

The int value to which subscanNumber is to be set.

void asdm::MainRow::setTime ( ArrayTime time )

Set time with the specified ArrayTime.

Parameters:

time

The ArrayTime value to which time is to be set.

Exceptions:

IllegalAccessException

If an attempt is made to change this field after is has been added to the table.

void asdm::MainRow::setTimeSampling ( TimeSamplingMod::TimeSampling timeSampling )

Set timeSampling with the specified TimeSamplingMod::TimeSampling.

Parameters:

timeSampling

The TimeSamplingMod::TimeSampling value to which timeSampling is to be set.

void asdm::MainRow::stateIdFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::stateIdFromText ( const string & s ) [private]

void asdm::MainRow::subscanNumberFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::subscanNumberFromText ( const string & s ) [private]

void asdm::MainRow::timeFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::timeFromText ( const string & s ) [private]

void asdm::MainRow::timeSamplingFromBin ( EndianIStream & eis ) [private]

void asdm::MainRow::timeSamplingFromText ( const string & s ) [private]

void asdm::MainRow::toBin ( EndianOSStream & eoss ) [private]

Serialize this into a stream of bytes written to an EndianOSStream.

Parameters:

eoss

the EndianOSStream to be written to

void asdm::MainRow::toIDL ( asdmIDL::MainRowIDL & x ) const

Define the content of a MainRowIDL struct from the values found in this row.

Parameters:

x

a reference to the MainRowIDL struct to be set.

asdmIDL::MainRowIDL* asdm::MainRow::toIDL ( ) const

Return this row in the form of an IDL struct.

Returns:: The values of this row as a MainRowIDL struct.

std::string asdm::MainRow::toXML ( ) const

Return this row in the form of an XML string.

Returns:: The values of this row as an XML string.

Friends And Related Function Documentation

friend class asdm::MainTable [friend]

Definition at line 133 of file MainRow.h.

friend class asdm::RowTransformer< MainRow > [friend]

Definition at line 134 of file MainRow.h.

Member Data Documentation

Extrinsic Table asdm::MainRow::Attributes

Definition at line 433 of file MainRow.h.

Extrinsic Table asdm::MainRow::Attributes

Definition at line 157 of file MainRow.h.

int64_t asdm::MainRow::dataSize [private]

===> Attribute dataSize

Definition at line 944 of file MainRow.h.

EntityRef asdm::MainRow::dataUID [private]

===> Attribute dataUID

Definition at line 955 of file MainRow.h.

Tag asdm::MainRow::execBlockId [private]

===> Attribute execBlockId

Definition at line 981 of file MainRow.h.

Tag asdm::MainRow::fieldId [private]

===> Attribute fieldId

Definition at line 992 of file MainRow.h.

Links* binary deserialization material from an EndianIStream std::map<std::string, MainAttributeFromBin> asdm::MainRow::fromBinMethods [private]

Definition at line 1045 of file MainRow.h.

* text deserialization material std::map<std::string, MainAttributeFromText> asdm::MainRow::fromTextMethods [private]

Definition at line 1066 of file MainRow.h.

bool asdm::MainRow::hasBeenAdded [private]

Whether this row has been added to the table or not.

Definition at line 823 of file MainRow.h.

Interval asdm::MainRow::interval [private]

===> Attribute interval

Definition at line 900 of file MainRow.h.

int asdm::MainRow::numAntenna [private]

===> Attribute numAntenna

Definition at line 878 of file MainRow.h.

int asdm::MainRow::numIntegration [private]

===> Attribute numIntegration

Definition at line 911 of file MainRow.h.

int asdm::MainRow::scanNumber [private]

===> Attribute scanNumber

Definition at line 922 of file MainRow.h.

vector<Tag> asdm::MainRow::stateId [private]

===> Attribute stateId

Definition at line 1003 of file MainRow.h.

int asdm::MainRow::subscanNumber [private]

===> Attribute subscanNumber

Definition at line 933 of file MainRow.h.

MainTable& asdm::MainRow::table [private]

The table to which this row belongs.

Definition at line 819 of file MainRow.h.

TimeSamplingMod::TimeSampling asdm::MainRow::timeSampling [private]

===> Attribute timeSampling

Definition at line 889 of file MainRow.h.

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

code/alma/ASDM/MainRow.h

asdm::MainRow Class Reference

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation