casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
asdm::SwitchCycleTable Class Reference

The SwitchCycleTable class is an Alma table. More...

#include <SwitchCycleTable.h>

Inheritance diagram for asdm::SwitchCycleTable:
asdm::Representable

Public Member Functions

virtual ~SwitchCycleTable ()
 
ASDMgetContainer () const
 Return the container to which this table belongs. More...
 
unsigned int size () const
 Return the number of rows in the table. More...
 
std::string getName () const
 Return the name of this table. More...
 
std::string getVersion () const
 Return the version information about this table. More...
 
Entity getEntity () const
 Return this table's Entity. More...
 
void setEntity (Entity e)
 Set this table's Entity. More...
 
std::string toXML ()
 Produces an XML representation conform to the schema defined for SwitchCycle (SwitchCycleTable.xsd). More...
 
asdmIDL::SwitchCycleTableIDL * toIDL ()
 Conversion Methods. More...
 
void toIDL (asdmIDL::SwitchCycleTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table. More...
 
void fromIDL (asdmIDL::SwitchCycleTableIDL x)
 Populate this table from the content of a SwitchCycleTableIDL Corba structure. More...
 
SwitchCycleRownewRow ()
 ====> Row creation. More...
 
SwitchCycleRownewRow (int numStep, std::vector< float > weightArray, std::vector< std::vector< Angle > > dirOffsetArray, std::vector< Frequency > freqOffsetArray, std::vector< Interval > stepDurationArray)
 Create a new row initialized to the specified values. More...
 
SwitchCycleRownewRow (SwitchCycleRow *row)
 Create a new row using a copy constructor mechanism. More...
 
SwitchCycleRowadd (SwitchCycleRow *x)
 ====> Append a row to its table. More...
 
std::vector< SwitchCycleRow * > get ()
 ====> Methods returning rows. More...
 
const std::vector
< SwitchCycleRow * > & 
get () const
 Get a const reference on the collection of rows pointers internally hold by the table. More...
 
SwitchCycleRowgetRowByKey (Tag switchCycleId)
 Returns a SwitchCycleRow* given a key. More...
 
SwitchCycleRowlookup (int numStep, std::vector< float > weightArray, std::vector< std::vector< Angle > > dirOffsetArray, std::vector< Frequency > freqOffsetArray, std::vector< Interval > stepDurationArray)
 Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method. More...
 
void setUnknownAttributeBinaryReader (const std::string &attributeName, BinaryAttributeReaderFunctor *barFctr)
 
BinaryAttributeReaderFunctorgetUnknownAttributeBinaryReader (const std::string &attributeName) const
 
- Public Member Functions inherited from asdm::Representable
virtual ~Representable ()
 

Static Public Member Functions

static const std::vector
< std::string > & 
getKeyName ()
 Return the list of field names that make up key key as an array of strings. More...
 
static std::string name ()
 Return the name of this table. More...
 
static const std::vector
< std::string > & 
getAttributesNames ()
 Return the names of the attributes of this table. More...
 
static const std::vector
< std::string > & 
defaultAttributesNamesInBin ()
 Return the default sorted list of attributes names in the binary representation of the table. More...
 

Private Member Functions

 SwitchCycleTable (ASDM &container)
 Create a SwitchCycleTable. More...
 
void autoIncrement (std::string key, SwitchCycleRow *x)
 
SwitchCycleRowcheckAndAdd (SwitchCycleRow *x, bool skipCheckUniqueness=false)
 If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not. More...
 
void append (SwitchCycleRow *x)
 Brutally append an SwitchCycleRow x to the collection of rows already stored in this table. More...
 
void addWithoutCheckingUnique (SwitchCycleRow *x)
 Brutally append an SwitchCycleRow x to the collection of rows already stored in this table. More...
 
void error ()
 
void fromXML (std::string &xmlDoc)
 Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a SwitchCycle (SwitchCycleTable.xsd). More...
 
void setFromMIMEFile (const std::string &directory)
 Private methods involved during the build of this table out of the content of file(s) containing an external representation of a SwitchCycle table. More...
 
void setFromXMLFile (const std::string &directory)
 
std::string toMIME (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
 Serialize this into a stream of bytes and encapsulates that stream into a MIME message. More...
 
void setFromMIME (const std::string &mimeMsg)
 Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization. More...
 
std::string MIMEXMLPart (const asdm::ByteOrder *byteOrder=asdm::ByteOrder::Machine_Endianity)
 Private methods involved during the export of this table into disk file(s). More...
 
void toFile (std::string directory)
 Stores a representation (binary or XML) of this table into a file. More...
 
void checkPresenceInMemory ()
 
void setFromFile (const std::string &directory)
 Reads and parses a file containing a representation of a SwitchCycleTable as those produced by the toFile method. More...
 

Private Attributes

ASDMcontainer
 
bool archiveAsBin
 
bool fileAsBin
 
std::string version
 
Entity entity
 
std::map< std::string, int > noAutoIncIds
 A map for the autoincrementation algorithm. More...
 
std::vector< SwitchCycleRow * > privateRows
 A data structure to store the pointers on the table's rows. More...
 
std::vector< SwitchCycleRow * > row
 
std::map< std::string,
BinaryAttributeReaderFunctor * > 
unknownAttributes2Functors
 
bool loadInProgress
 Load the table in memory if necessary. More...
 

Friends

class ASDM
 

Additional Inherited Members

- Protected Attributes inherited from asdm::Representable
bool presentInMemory
 
bool loadInProgress
 
uint32_t declaredSize
 

Detailed Description

The SwitchCycleTable class is an Alma table.


Role
Cycle information in switching modes. Describe each step in a switching cycle.

Generated from model's revision "-1", branch ""

Attributes of SwitchCycle
Name Type Expected shape

Comment

Key

switchCycleId

Tag  

 identifies a unique row in the table.

Value
(Mandatory)

numStep (numStep) int  

 the number of steps.

weightArray std::vector<float > numStep

 the weights (one value per step).

dirOffsetArray std::vector<std::vector<Angle > > numStep, 2

 the pointing direction offsets (one pair per step).

freqOffsetArray std::vector<Frequency > numStep

 the frequencies offsets (one value per step).

stepDurationArray std::vector<Interval > numStep

 the duration of the steps (one value per steps).

Value
(Optional)

directionCode DirectionReferenceCodeMod::DirectionReferenceCode  

  the reference frame associated to dirOffsetArray.t

directionEquinox ArrayTime  

  the equinox associated to directionCode (if required).

Definition at line 193 of file SwitchCycleTable.h.

Constructor & Destructor Documentation

virtual asdm::SwitchCycleTable::~SwitchCycleTable ( )
virtual
asdm::SwitchCycleTable::SwitchCycleTable ( ASDM container)
private

Create a SwitchCycleTable.

This constructor is private because only the container can create tables. All tables must know the container to which they belong.

Parameters
containerThe container to which this table belongs.

Member Function Documentation

SwitchCycleRow* asdm::SwitchCycleTable::add ( SwitchCycleRow x)

====> Append a row to its table.

Add a row. If there table contains a row whose key's fields are equal to x's ones then return a pointer on this row (i.e. no actual insertion is performed) otherwise add x to the table and return x.

Parameters
x. A pointer on the row to be added.
Returns
a pointer to a SwitchCycleRow.
void asdm::SwitchCycleTable::addWithoutCheckingUnique ( SwitchCycleRow x)
private

Brutally append an SwitchCycleRow x to the collection of rows already stored in this table.

No uniqueness check is done !

Parameters
SwitchCycleRow*x a pointer onto the SwitchCycleRow to be appended.
void asdm::SwitchCycleTable::append ( SwitchCycleRow x)
private

Brutally append an SwitchCycleRow x to the collection of rows already stored in this table.

No uniqueness check is done !

Parameters
SwitchCycleRow*x a pointer onto the SwitchCycleRow to be appended.
void asdm::SwitchCycleTable::autoIncrement ( std::string  key,
SwitchCycleRow x 
)
private
SwitchCycleRow* asdm::SwitchCycleTable::checkAndAdd ( SwitchCycleRow x,
bool  skipCheckUniqueness = false 
)
private

If this table has an autoincrementable attribute then check if *x verifies the rule of uniqueness and throw exception if not.

Check if *x verifies the key uniqueness rule and throw an exception if not. Append x to its table.

Exceptions
DuplicateKey
UniquenessViolationException
void asdm::SwitchCycleTable::checkPresenceInMemory ( )
inlineprivate
static const std::vector<std::string>& asdm::SwitchCycleTable::defaultAttributesNamesInBin ( )
static

Return the default sorted list of attributes names in the binary representation of the table.

Returns
a const reference to a vector of string
void asdm::SwitchCycleTable::error ( )
private
void asdm::SwitchCycleTable::fromIDL ( asdmIDL::SwitchCycleTableIDL  x)

Populate this table from the content of a SwitchCycleTableIDL Corba structure.

Exceptions
DuplicateKeyThrown if the method tries to add a row having a key that is already in the table.
ConversionException
void asdm::SwitchCycleTable::fromXML ( std::string &  xmlDoc)
privatevirtual

Populate this table from the content of a XML document that is required to be conform to the XML schema defined for a SwitchCycle (SwitchCycleTable.xsd).

Exceptions
ConversionException

Implements asdm::Representable.

std::vector<SwitchCycleRow *> asdm::SwitchCycleTable::get ( )

====> Methods returning rows.

Get a collection of pointers on the rows of the table.

Returns
Alls rows in a vector of pointers of SwitchCycleRow. The elements of this vector are stored in the order in which they have been added to the SwitchCycleTable.
const std::vector<SwitchCycleRow *>& asdm::SwitchCycleTable::get ( ) const

Get a const reference on the collection of rows pointers internally hold by the table.

Returns
A const reference of a vector of pointers of SwitchCycleRow. The elements of this vector are stored in the order in which they have been added to the SwitchCycleTable.
static const std::vector<std::string>& asdm::SwitchCycleTable::getAttributesNames ( )
static

Return the names of the attributes of this table.

Returns
a vector of string
ASDM& asdm::SwitchCycleTable::getContainer ( ) const

Return the container to which this table belongs.

Returns
the ASDM containing this table.

Referenced by checkPresenceInMemory().

Entity asdm::SwitchCycleTable::getEntity ( ) const
virtual

Return this table's Entity.

Implements asdm::Representable.

static const std::vector<std::string>& asdm::SwitchCycleTable::getKeyName ( )
static

Return the list of field names that make up key key as an array of strings.

Returns
a vector of string.
std::string asdm::SwitchCycleTable::getName ( ) const
virtual

Return the name of this table.

This is a instance method of the class.

Returns
the name of this table in a string.

Implements asdm::Representable.

SwitchCycleRow* asdm::SwitchCycleTable::getRowByKey ( Tag  switchCycleId)

Returns a SwitchCycleRow* given a key.

Returns
a pointer to the row having the key whose values are passed as parameters, or 0 if no row exists for that key.
Parameters
switchCycleId
BinaryAttributeReaderFunctor* asdm::SwitchCycleTable::getUnknownAttributeBinaryReader ( const std::string &  attributeName) const
std::string asdm::SwitchCycleTable::getVersion ( ) const

Return the version information about this table.

SwitchCycleRow* asdm::SwitchCycleTable::lookup ( int  numStep,
std::vector< float >  weightArray,
std::vector< std::vector< Angle > >  dirOffsetArray,
std::vector< Frequency freqOffsetArray,
std::vector< Interval stepDurationArray 
)

Look up the table for a row whose all attributes except the autoincrementable one are equal to the corresponding parameters of the method.

Returns
a pointer on this row if any, null otherwise.
Parameters
numStep
weightArray
dirOffsetArray
freqOffsetArray
stepDurationArray
std::string asdm::SwitchCycleTable::MIMEXMLPart ( const asdm::ByteOrder byteOrder = asdm::ByteOrder::Machine_Endianity)
private

Private methods involved during the export of this table into disk file(s).

static std::string asdm::SwitchCycleTable::name ( )
static

Return the name of this table.

This is a static method of the class.

Returns
the name of this table in a string.
SwitchCycleRow* asdm::SwitchCycleTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns
a pointer on a SwitchCycleRow
SwitchCycleRow* asdm::SwitchCycleTable::newRow ( int  numStep,
std::vector< float >  weightArray,
std::vector< std::vector< Angle > >  dirOffsetArray,
std::vector< Frequency freqOffsetArray,
std::vector< Interval stepDurationArray 
)

Create a new row initialized to the specified values.

Returns
a pointer on the created and initialized row.
Parameters
numStep
weightArray
dirOffsetArray
freqOffsetArray
stepDurationArray
SwitchCycleRow* asdm::SwitchCycleTable::newRow ( SwitchCycleRow row)

Create a new row using a copy constructor mechanism.

The method creates a new SwitchCycleRow owned by this. Each attribute of the created row is a (deep) copy of the corresponding attribute of row. The method does not add the created row to this, its simply parents it to this, 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 new SwitchCycleRow with default values for its attributes.

Parameters
rowthe row which is to be copied.
void asdm::SwitchCycleTable::setEntity ( Entity  e)
virtual

Set this table's Entity.

Parameters
eAn entity.

Implements asdm::Representable.

void asdm::SwitchCycleTable::setFromFile ( const std::string &  directory)
private

Reads and parses a file containing a representation of a SwitchCycleTable as those produced by the toFile method.

This table is populated with the result of the parsing.

Parameters
directoryThe name of the directory containing the file te be read and parsed.
Exceptions
ConversionExceptionIf any error occurs while reading the files in the directory or parsing them.

Referenced by checkPresenceInMemory().

void asdm::SwitchCycleTable::setFromMIME ( const std::string &  mimeMsg)
private

Extracts the binary part of a MIME message and deserialize its content to fill this with the result of the deserialization.

Parameters
mimeMsgthe string containing the MIME message.
Exceptions
ConversionException
void asdm::SwitchCycleTable::setFromMIMEFile ( const std::string &  directory)
private

Private methods involved during the build of this table out of the content of file(s) containing an external representation of a SwitchCycle table.

void asdm::SwitchCycleTable::setFromXMLFile ( const std::string &  directory)
private
void asdm::SwitchCycleTable::setUnknownAttributeBinaryReader ( const std::string &  attributeName,
BinaryAttributeReaderFunctor barFctr 
)
unsigned int asdm::SwitchCycleTable::size ( ) const
virtual

Return the number of rows in the table.

Returns
the number of rows in an unsigned int.

Implements asdm::Representable.

void asdm::SwitchCycleTable::toFile ( std::string  directory)
private

Stores a representation (binary or XML) of this table into a file.

Depending on the boolean value of its private field fileAsBin a binary serialization of this (fileAsBin==true) will be saved in a file "SwitchCycle.bin" or an XML representation (fileAsBin==false) will be saved in a file "SwitchCycle.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters
directoryThe name of directory where the file containing the table's representation will be saved.
asdmIDL::SwitchCycleTableIDL* asdm::SwitchCycleTable::toIDL ( )

Conversion Methods.

Convert this table into a SwitchCycleTableIDL CORBA structure.

Returns
a pointer to a SwitchCycleTableIDL
void asdm::SwitchCycleTable::toIDL ( asdmIDL::SwitchCycleTableIDL &  x) const

Fills the CORBA data structure passed in parameter with the content of this table.

Parameters
xa reference to the asdmIDL::SwitchCycleTableIDL to be populated with the content of this.
std::string asdm::SwitchCycleTable::toMIME ( const asdm::ByteOrder byteOrder = asdm::ByteOrder::Machine_Endianity)
private

Serialize this into a stream of bytes and encapsulates that stream into a MIME message.

Returns
a string containing the MIME message.
Parameters
byteOrdera const pointer to a static instance of the class ByteOrder.
std::string asdm::SwitchCycleTable::toXML ( )
virtual

Produces an XML representation conform to the schema defined for SwitchCycle (SwitchCycleTable.xsd).

Returns
a string containing the XML representation.
Exceptions
ConversionException

Implements asdm::Representable.

Friends And Related Function Documentation

friend class ASDM
friend

Definition at line 194 of file SwitchCycleTable.h.

Member Data Documentation

bool asdm::SwitchCycleTable::archiveAsBin
private

Definition at line 450 of file SwitchCycleTable.h.

ASDM& asdm::SwitchCycleTable::container
private

Definition at line 448 of file SwitchCycleTable.h.

Entity asdm::SwitchCycleTable::entity
private

Definition at line 455 of file SwitchCycleTable.h.

bool asdm::SwitchCycleTable::fileAsBin
private

Definition at line 451 of file SwitchCycleTable.h.

bool asdm::SwitchCycleTable::loadInProgress
private

Load the table in memory if necessary.

Definition at line 565 of file SwitchCycleTable.h.

Referenced by checkPresenceInMemory().

std::map<std::string,int> asdm::SwitchCycleTable::noAutoIncIds
private

A map for the autoincrementation algorithm.

Definition at line 462 of file SwitchCycleTable.h.

std::vector<SwitchCycleRow * > asdm::SwitchCycleTable::privateRows
private

A data structure to store the pointers on the table's rows.

In all cases we maintain a private vector of SwitchCycleRow s.

Definition at line 498 of file SwitchCycleTable.h.

std::vector<SwitchCycleRow *> asdm::SwitchCycleTable::row
private

Definition at line 502 of file SwitchCycleTable.h.

std::map<std::string, BinaryAttributeReaderFunctor *> asdm::SwitchCycleTable::unknownAttributes2Functors
private

Definition at line 516 of file SwitchCycleTable.h.

std::string asdm::SwitchCycleTable::version
private

Definition at line 453 of file SwitchCycleTable.h.


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