asdm::StationRow Class Reference

The StationRow class is a row of a StationTable. More...

#include <StationRow.h>

Public Member Functions
virtual	~StationRow ()
	friend class asdm::TableStreamReader<StationTable, StationRow>;
StationTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
string	getName () const
	===> Attribute name
void	setName (string name)
	Set name with the specified string.
vector< Length >	getPosition () const
	===> Attribute position
void	setPosition (vector< Length > position)
	Set position with the specified vector<Length >.
StationTypeMod::StationType	getType () const
	===> Attribute type
void	setType (StationTypeMod::StationType type)
	Set type with the specified StationTypeMod::StationType.
bool	isTimeExists () const
	===> Attribute time, which is optional
ArrayTime	getTime () const
	Get time, which is optional.
void	setTime (ArrayTime time)
	Set time with the specified ArrayTime.
void	clearTime ()
	Mark time, which is an optional field, as non-existent.
Extrinsic Table Attributes Links *bool	compareNoAutoInc (string name, vector< Length > position, StationTypeMod::StationType type)
	Compare each mandatory attribute except the autoincrementable one of this StationRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (string name, vector< Length > position, StationTypeMod::StationType type)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (StationRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::StationRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::StationRowIDL &x) const
	Define the content of a StationRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::StationRowIDL x)
	Fill the values of this row from the IDL struct StationRowIDL.
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
Private Member Functions
void	isAdded (bool added)
	This method is used by the Table class when this row is added to the table.
	StationRow (StationTable &table)
	Create a StationRow.
	StationRow (StationTable &table, StationRow &row)
	Create a StationRow using a copy constructor mechanism.
void	setStationId (Tag stationId)
	Set stationId with the specified Tag value.
void	stationIdFromBin (EndianIStream &eis)
void	nameFromBin (EndianIStream &eis)
void	positionFromBin (EndianIStream &eis)
void	typeFromBin (EndianIStream &eis)
void	timeFromBin (EndianIStream &eis)
void	stationIdFromText (const string &s)
void	nameFromText (const string &s)
void	positionFromText (const string &s)
void	typeFromText (const string &s)
void	timeFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
StationTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
string	name
	===> Attribute name
vector< Length >	position
	===> Attribute position
StationTypeMod::StationType	type
	===> Attribute type
bool	timeExists
	===> Attribute time, which is optional
ArrayTime	time
Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, StationAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, StationAttributeFromText >	fromTextMethods
Friends
class	asdm::StationTable
class	asdm::RowTransformer< StationRow >

Detailed Description

The StationRow class is a row of a StationTable.

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

Definition at line 106 of file StationRow.h.

Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<StationTable, StationRow>;

asdm::StationRow::StationRow ( StationTable & table ) [private]

Create a StationRow.

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::StationRow::StationRow	(	StationTable &	table,
		StationRow &	row
	)			`[private]`

Create a StationRow using a copy constructor mechanism.

Given a StationRow row and a StationTable table, the method creates a new StationRow 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::StationRow::clearTime ( )

Mark time, which is an optional field, as non-existent.

Extrinsic Table Attributes Links* bool asdm::StationRow::compareNoAutoInc	(	string	name,
		vector< Length >	position,
		StationTypeMod::StationType	type
	)

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

Parameters:

	name
	position
	type

bool asdm::StationRow::compareRequiredValue	(	string	name,
		vector< Length >	position,
		StationTypeMod::StationType	type
	)

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:

	name
	position
	type

bool asdm::StationRow::equalByRequiredValue ( StationRow * 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 StationRow whose required attributes of the value part will be compared with those of this.

Returns:: a boolean.

string asdm::StationRow::getName ( ) const

===> Attribute name

Get name.

Returns:: name as string

vector<Length > asdm::StationRow::getPosition ( ) const

===> Attribute position

Get position.

Returns:: position as vector<Length >

StationTable& asdm::StationRow::getTable ( ) const

Return the table to which this row belongs.

ArrayTime asdm::StationRow::getTime ( ) const

Get time, which is optional.

Returns:: time as ArrayTime

Exceptions:

IllegalAccessException

If time does not exist.

StationTypeMod::StationType asdm::StationRow::getType ( ) const

===> Attribute type

Get type.

Returns:: type as StationTypeMod::StationType

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

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

bool asdm::StationRow::isAdded ( ) const

Has this row been added to its table ?

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

bool asdm::StationRow::isTimeExists ( ) const

===> Attribute time, which is optional

The attribute time is optional. Return true if this attribute exists.

Returns:: true if and only if the time attribute exists.

void asdm::StationRow::nameFromBin ( EndianIStream & eis ) [private]

void asdm::StationRow::nameFromText ( const string & s ) [private]

void asdm::StationRow::positionFromBin ( EndianIStream & eis ) [private]

void asdm::StationRow::positionFromText ( const string & s ) [private]

void asdm::StationRow::setFromIDL ( asdmIDL::StationRowIDL x )

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::StationRow::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::StationRow::setName ( string name )

Set name with the specified string.

Parameters:

name

The string value to which name is to be set.

void asdm::StationRow::setPosition ( vector< Length > position )

Set position with the specified vector<Length >.

Parameters:

position

The vector<Length > value to which position is to be set.

void asdm::StationRow::setStationId ( Tag stationId ) [private]

Set stationId with the specified Tag value.

Parameters:

stationId

The Tag value to which stationId 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::StationRow::setTime ( ArrayTime time )

Set time with the specified ArrayTime.

Parameters:

time

The ArrayTime value to which time is to be set.

void asdm::StationRow::setType ( StationTypeMod::StationType type )

Set type with the specified StationTypeMod::StationType.

Parameters:

type

The StationTypeMod::StationType value to which type is to be set.

void asdm::StationRow::stationIdFromBin ( EndianIStream & eis ) [private]

void asdm::StationRow::stationIdFromText ( const string & s ) [private]

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

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

void asdm::StationRow::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::StationRow::toIDL ( asdmIDL::StationRowIDL & x ) const

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

Parameters:

x

a reference to the StationRowIDL struct to be set.

asdmIDL::StationRowIDL* asdm::StationRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

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

Return this row in the form of an XML string.

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

void asdm::StationRow::typeFromBin ( EndianIStream & eis ) [private]

void asdm::StationRow::typeFromText ( const string & s ) [private]

Friends And Related Function Documentation

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

Definition at line 108 of file StationRow.h.

friend class asdm::StationTable [friend]

Definition at line 107 of file StationRow.h.

Member Data Documentation

Intrinsic Table asdm::StationRow::Attributes

Definition at line 131 of file StationRow.h.

Extrinsic Table Attributes Links* binary deserialization material from an EndianIStream std::map<std::string, StationAttributeFromBin> asdm::StationRow::fromBinMethods [private]

Definition at line 533 of file StationRow.h.

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

Definition at line 546 of file StationRow.h.

bool asdm::StationRow::hasBeenAdded [private]

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

Definition at line 412 of file StationRow.h.

string asdm::StationRow::name [private]

===> Attribute name

Definition at line 479 of file StationRow.h.

vector<Length > asdm::StationRow::position [private]

===> Attribute position

Definition at line 490 of file StationRow.h.

StationTable& asdm::StationRow::table [private]

The table to which this row belongs.

Definition at line 408 of file StationRow.h.

ArrayTime asdm::StationRow::time [private]

Definition at line 514 of file StationRow.h.

bool asdm::StationRow::timeExists [private]

===> Attribute time, which is optional

Definition at line 511 of file StationRow.h.

StationTypeMod::StationType asdm::StationRow::type [private]

===> Attribute type

Definition at line 501 of file StationRow.h.

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

code/alma/ASDM/StationRow.h

asdm::StationRow 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