asdm::StateRow Class Reference

The StateRow class is a row of a StateTable. More...

#include <StateRow.h>

Public Member Functions
virtual	~StateRow ()
	friend class asdm::TableStreamReader<StateTable, StateRow>;
StateTable &	getTable () const
	Return the table to which this row belongs.
bool	isAdded () const
	Has this row been added to its table ?
CalibrationDeviceMod::CalibrationDevice	getCalDeviceName () const
	===> Attribute calDeviceName
void	setCalDeviceName (CalibrationDeviceMod::CalibrationDevice calDeviceName)
	Set calDeviceName with the specified CalibrationDeviceMod::CalibrationDevice.
bool	getSig () const
	===> Attribute sig
void	setSig (bool sig)
	Set sig with the specified bool.
bool	getRef () const
	===> Attribute ref
void	setRef (bool ref)
	Set ref with the specified bool.
bool	getOnSky () const
	===> Attribute onSky
void	setOnSky (bool onSky)
	Set onSky with the specified bool.
bool	isWeightExists () const
	===> Attribute weight, which is optional
float	getWeight () const
	Get weight, which is optional.
void	setWeight (float weight)
	Set weight with the specified float.
void	clearWeight ()
	Mark weight, which is an optional field, as non-existent.
Extrinsic Table Attributes Links *bool	compareNoAutoInc (CalibrationDeviceMod::CalibrationDevice calDeviceName, bool sig, bool ref, bool onSky)
	Compare each mandatory attribute except the autoincrementable one of this StateRow with the corresponding parameters and return true if there is a match and false otherwise.
bool	compareRequiredValue (CalibrationDeviceMod::CalibrationDevice calDeviceName, bool sig, bool ref, bool onSky)
	Compare each mandatory value (i.e.
bool	equalByRequiredValue (StateRow *x)
	Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
asdmIDL::StateRowIDL *	toIDL () const
	Return this row in the form of an IDL struct.
void	toIDL (asdmIDL::StateRowIDL &x) const
	Define the content of a StateRowIDL struct from the values found in this row.
void	setFromIDL (asdmIDL::StateRowIDL x)
	Fill the values of this row from the IDL struct StateRowIDL.
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.
	StateRow (StateTable &table)
	Create a StateRow.
	StateRow (StateTable &table, StateRow &row)
	Create a StateRow using a copy constructor mechanism.
void	setStateId (Tag stateId)
	Set stateId with the specified Tag value.
void	stateIdFromBin (EndianIStream &eis)
void	calDeviceNameFromBin (EndianIStream &eis)
void	sigFromBin (EndianIStream &eis)
void	refFromBin (EndianIStream &eis)
void	onSkyFromBin (EndianIStream &eis)
void	weightFromBin (EndianIStream &eis)
void	stateIdFromText (const string &s)
void	calDeviceNameFromText (const string &s)
void	sigFromText (const string &s)
void	refFromText (const string &s)
void	onSkyFromText (const string &s)
void	weightFromText (const string &s)
void	toBin (EndianOSStream &eoss)
	Serialize this into a stream of bytes written to an EndianOSStream.
Private Attributes
StateTable &	table
	The table to which this row belongs.
bool	hasBeenAdded
	Whether this row has been added to the table or not.
CalibrationDeviceMod::CalibrationDevice	calDeviceName
	===> Attribute calDeviceName
bool	sig
	===> Attribute sig
bool	ref
	===> Attribute ref
bool	onSky
	===> Attribute onSky
bool	weightExists
	===> Attribute weight, which is optional
float	weight
Extrinsic Table Attributes Links *binary deserialization material from an EndianIStream std::map< std::string, StateAttributeFromBin >	fromBinMethods
*text deserialization material std::map< std::string, StateAttributeFromText >	fromTextMethods
Friends
class	asdm::StateTable
class	asdm::RowTransformer< StateRow >

Detailed Description

The StateRow class is a row of a StateTable.

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

Definition at line 100 of file StateRow.h.

Constructor & Destructor Documentation

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

friend class asdm::TableStreamReader<StateTable, StateRow>;

asdm::StateRow::StateRow ( StateTable & table ) [private]

Create a StateRow.

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

Create a StateRow using a copy constructor mechanism.

Given a StateRow row and a StateTable table, the method creates a new StateRow 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::StateRow::calDeviceNameFromBin ( EndianIStream & eis ) [private]

void asdm::StateRow::calDeviceNameFromText ( const string & s ) [private]

void asdm::StateRow::clearWeight ( )

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

Extrinsic Table Attributes Links* bool asdm::StateRow::compareNoAutoInc	(	CalibrationDeviceMod::CalibrationDevice	calDeviceName,
		bool	sig,
		bool	ref,
		bool	onSky
	)

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

Parameters:

	calDeviceName
	sig
	ref
	onSky

bool asdm::StateRow::compareRequiredValue	(	CalibrationDeviceMod::CalibrationDevice	calDeviceName,
		bool	sig,
		bool	ref,
		bool	onSky
	)

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:

	calDeviceName
	sig
	ref
	onSky

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

Returns:: a boolean.

CalibrationDeviceMod::CalibrationDevice asdm::StateRow::getCalDeviceName ( ) const

===> Attribute calDeviceName

Get calDeviceName.

Returns:: calDeviceName as CalibrationDeviceMod::CalibrationDevice

bool asdm::StateRow::getOnSky ( ) const

===> Attribute onSky

Get onSky.

Returns:: onSky as bool

bool asdm::StateRow::getRef ( ) const

===> Attribute ref

Get ref.

Returns:: ref as bool

bool asdm::StateRow::getSig ( ) const

===> Attribute sig

Get sig.

Returns:: sig as bool

StateTable& asdm::StateRow::getTable ( ) const

Return the table to which this row belongs.

float asdm::StateRow::getWeight ( ) const

Get weight, which is optional.

Returns:: weight as float

Exceptions:

IllegalAccessException

If weight does not exist.

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

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

bool asdm::StateRow::isAdded ( ) const

Has this row been added to its table ?

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

bool asdm::StateRow::isWeightExists ( ) const

===> Attribute weight, which is optional

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

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

void asdm::StateRow::onSkyFromBin ( EndianIStream & eis ) [private]

void asdm::StateRow::onSkyFromText ( const string & s ) [private]

void asdm::StateRow::refFromBin ( EndianIStream & eis ) [private]

void asdm::StateRow::refFromText ( const string & s ) [private]

void asdm::StateRow::setCalDeviceName ( CalibrationDeviceMod::CalibrationDevice calDeviceName )

Set calDeviceName with the specified CalibrationDeviceMod::CalibrationDevice.

Parameters:

calDeviceName

The CalibrationDeviceMod::CalibrationDevice value to which calDeviceName is to be set.

void asdm::StateRow::setFromIDL ( asdmIDL::StateRowIDL x )

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

Parameters:

x

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

Exceptions:

ConversionException

void asdm::StateRow::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::StateRow::setOnSky ( bool onSky )

Set onSky with the specified bool.

Parameters:

onSky

The bool value to which onSky is to be set.

void asdm::StateRow::setRef ( bool ref )

Set ref with the specified bool.

Parameters:

ref

The bool value to which ref is to be set.

void asdm::StateRow::setSig ( bool sig )

Set sig with the specified bool.

Parameters:

sig

The bool value to which sig is to be set.

void asdm::StateRow::setStateId ( Tag stateId ) [private]

Set stateId with the specified Tag value.

Parameters:

stateId

The Tag value to which stateId 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::StateRow::setWeight ( float weight )

Set weight with the specified float.

Parameters:

weight

The float value to which weight is to be set.

void asdm::StateRow::sigFromBin ( EndianIStream & eis ) [private]

void asdm::StateRow::sigFromText ( const string & s ) [private]

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

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

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

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

Parameters:

x

a reference to the StateRowIDL struct to be set.

asdmIDL::StateRowIDL* asdm::StateRow::toIDL ( ) const

Return this row in the form of an IDL struct.

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

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

Return this row in the form of an XML string.

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

void asdm::StateRow::weightFromBin ( EndianIStream & eis ) [private]

void asdm::StateRow::weightFromText ( const string & s ) [private]

Friends And Related Function Documentation

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

Definition at line 102 of file StateRow.h.

friend class asdm::StateTable [friend]

Definition at line 101 of file StateRow.h.

Member Data Documentation

Intrinsic Table asdm::StateRow::Attributes

Definition at line 125 of file StateRow.h.

CalibrationDeviceMod::CalibrationDevice asdm::StateRow::calDeviceName [private]

===> Attribute calDeviceName

Definition at line 508 of file StateRow.h.

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

Definition at line 573 of file StateRow.h.

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

Definition at line 587 of file StateRow.h.

bool asdm::StateRow::hasBeenAdded [private]

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

Definition at line 441 of file StateRow.h.

bool asdm::StateRow::onSky [private]

===> Attribute onSky

Definition at line 541 of file StateRow.h.

bool asdm::StateRow::ref [private]

===> Attribute ref

Definition at line 530 of file StateRow.h.

bool asdm::StateRow::sig [private]

===> Attribute sig

Definition at line 519 of file StateRow.h.

StateTable& asdm::StateRow::table [private]

The table to which this row belongs.

Definition at line 437 of file StateRow.h.

float asdm::StateRow::weight [private]

Definition at line 554 of file StateRow.h.

bool asdm::StateRow::weightExists [private]

===> Attribute weight, which is optional

Definition at line 551 of file StateRow.h.

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

code/alma/ASDM/StateRow.h

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