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::FlagCmdTable Class Reference

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

#include <FlagCmdTable.h>

Inheritance diagram for asdm::FlagCmdTable:
asdm::Representable

Public Member Functions

virtual ~FlagCmdTable ()
 
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 FlagCmd (FlagCmdTable.xsd). More...
 
asdmIDL::FlagCmdTableIDL * toIDL ()
 Conversion Methods. More...
 
void toIDL (asdmIDL::FlagCmdTableIDL &x) const
 Fills the CORBA data structure passed in parameter with the content of this table. More...
 
void fromIDL (asdmIDL::FlagCmdTableIDL x)
 Populate this table from the content of a FlagCmdTableIDL Corba structure. More...
 
FlagCmdRownewRow ()
 ====> Row creation. More...
 
FlagCmdRownewRow (ArrayTimeInterval timeInterval, std::string type, std::string reason, int level, int severity, bool applied, std::string command)
 Create a new row initialized to the specified values. More...
 
FlagCmdRownewRow (FlagCmdRow *row)
 Create a new row using a copy constructor mechanism. More...
 
FlagCmdRowadd (FlagCmdRow *x)
 ====> Append a row to its table. More...
 
std::vector< FlagCmdRow * > get ()
 ====> Methods returning rows. More...
 
const std::vector< FlagCmdRow * > & get () const
 Get a const reference on the collection of rows pointers internally hold by the table. More...
 
std::vector< FlagCmdRow * > * getByContext ()
 Returns all the rows sorted by ascending startTime for a given context. More...
 
FlagCmdRowgetRowByKey (ArrayTimeInterval timeInterval)
 Returns a FlagCmdRow* given a key. More...
 
FlagCmdRowlookup (ArrayTimeInterval timeInterval, std::string type, std::string reason, int level, int severity, bool applied, std::string command)
 Look up the table for a row whose all attributes 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

 FlagCmdTable (ASDM &container)
 Create a FlagCmdTable. More...
 
FlagCmdRowcheckAndAdd (FlagCmdRow *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 (FlagCmdRow *x)
 Brutally append an FlagCmdRow x to the collection of rows already stored in this table. More...
 
void addWithoutCheckingUnique (FlagCmdRow *x)
 Brutally append an FlagCmdRow x to the collection of rows already stored in this table. More...
 
FlagCmdRowinsertByStartTime (FlagCmdRow *x, std::vector< FlagCmdRow * > &row)
 Insert a FlagCmdRow* in a vector of FlagCmdRow* so that it's ordered by ascending time. 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 FlagCmd (FlagCmdTable.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 FlagCmd 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 FlagCmdTable as those produced by the toFile method. More...
 

Private Attributes

ASDMcontainer
 
bool archiveAsBin
 
bool fileAsBin
 
std::string version
 
Entity entity
 
std::vector< FlagCmdRow * > privateRows
 A data structure to store the pointers on the table's rows. More...
 
std::vector< FlagCmdRow * > 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 FlagCmdTable class is an Alma table.


Role
Flag commands.

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

Attributes of FlagCmd
Name Type Expected shape

Comment

Key

timeInterval

ArrayTimeInterval  

 

Value
(Mandatory)

type std::string  

 

reason std::string  

 

level int  

 

severity int  

 

applied bool  

 

command std::string  

 

Definition at line 163 of file FlagCmdTable.h.

Constructor & Destructor Documentation

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

Create a FlagCmdTable.

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

FlagCmdRow* asdm::FlagCmdTable::add ( FlagCmdRow x)

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

Add a row.

Parameters
xa pointer to the FlagCmdRow to be added.
Returns
a pointer to a FlagCmdRow. If the table contains a FlagCmdRow whose attributes (key and mandatory values) are equal to x ones then returns a pointer on that FlagCmdRow, otherwise returns x.
Exceptions
DuplicateKey{ thrown when the table contains a FlagCmdRow with a key equal to the x one but having and a value section different from x one }
Note
The row is inserted in the table in such a way that all the rows having the same value of ( ) are stored by ascending time.
See Also
method getByContext.
void asdm::FlagCmdTable::addWithoutCheckingUnique ( FlagCmdRow x)
private

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

No uniqueness check is done !

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

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

No uniqueness check is done !

Parameters
FlagCmdRow*x a pointer onto the FlagCmdRow to be appended.
FlagCmdRow* asdm::FlagCmdTable::checkAndAdd ( FlagCmdRow 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
void asdm::FlagCmdTable::checkPresenceInMemory ( )
inlineprivate
static const std::vector<std::string>& asdm::FlagCmdTable::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::FlagCmdTable::error ( )
private
void asdm::FlagCmdTable::fromIDL ( asdmIDL::FlagCmdTableIDL  x)

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

Exceptions
DuplicateKeyThrown if the method tries to add a row having a key that is already in the table.
ConversionException
void asdm::FlagCmdTable::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 FlagCmd (FlagCmdTable.xsd).

Exceptions
ConversionException

Implements asdm::Representable.

std::vector<FlagCmdRow *> asdm::FlagCmdTable::get ( )

====> Methods returning rows.

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

Returns
Alls rows in a vector of pointers of FlagCmdRow. The elements of this vector are stored in the order in which they have been added to the FlagCmdTable.
const std::vector<FlagCmdRow *>& asdm::FlagCmdTable::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 FlagCmdRow. The elements of this vector are stored in the order in which they have been added to the FlagCmdTable.
static const std::vector<std::string>& asdm::FlagCmdTable::getAttributesNames ( )
static

Return the names of the attributes of this table.

Returns
a vector of string
std::vector<FlagCmdRow*>* asdm::FlagCmdTable::getByContext ( )

Returns all the rows sorted by ascending startTime for a given context.

The context is defined by a value of ( ).

Returns
a pointer on a vector<FlagCmdRow *>. A null returned value means that the table contains no FlagCmdRow for the given ( ).
Exceptions
IllegalAccessExceptionwhen a call is done to this method when it's called while the dataset has been imported with the option checkRowUniqueness set to false.
ASDM& asdm::FlagCmdTable::getContainer ( ) const

Return the container to which this table belongs.

Returns
the ASDM containing this table.

Referenced by checkPresenceInMemory().

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

Return this table's Entity.

Implements asdm::Representable.

static const std::vector<std::string>& asdm::FlagCmdTable::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::FlagCmdTable::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.

FlagCmdRow* asdm::FlagCmdTable::getRowByKey ( ArrayTimeInterval  timeInterval)

Returns a FlagCmdRow* 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
timeInterval
BinaryAttributeReaderFunctor* asdm::FlagCmdTable::getUnknownAttributeBinaryReader ( const std::string &  attributeName) const
std::string asdm::FlagCmdTable::getVersion ( ) const

Return the version information about this table.

FlagCmdRow* asdm::FlagCmdTable::insertByStartTime ( FlagCmdRow x,
std::vector< FlagCmdRow * > &  row 
)
private

Insert a FlagCmdRow* in a vector of FlagCmdRow* so that it's ordered by ascending time.

Parameters
FlagCmdRow*x . The pointer to be inserted.
vector<FlagCmdRow*>& row . A reference to the vector where to insert x.
FlagCmdRow* asdm::FlagCmdTable::lookup ( ArrayTimeInterval  timeInterval,
std::string  type,
std::string  reason,
int  level,
int  severity,
bool  applied,
std::string  command 
)

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

Returns
a pointer on this row if any, null otherwise.
Parameters
timeInterval
type
reason
level
severity
applied
command
std::string asdm::FlagCmdTable::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::FlagCmdTable::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.
FlagCmdRow* asdm::FlagCmdTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns
a pointer on a FlagCmdRow
FlagCmdRow* asdm::FlagCmdTable::newRow ( ArrayTimeInterval  timeInterval,
std::string  type,
std::string  reason,
int  level,
int  severity,
bool  applied,
std::string  command 
)

Create a new row initialized to the specified values.

Returns
a pointer on the created and initialized row.
Parameters
timeInterval
type
reason
level
severity
applied
command
FlagCmdRow* asdm::FlagCmdTable::newRow ( FlagCmdRow row)

Create a new row using a copy constructor mechanism.

The method creates a new FlagCmdRow 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 FlagCmdRow with default values for its attributes.

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

Set this table's Entity.

Parameters
eAn entity.

Implements asdm::Representable.

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

Reads and parses a file containing a representation of a FlagCmdTable 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::FlagCmdTable::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::FlagCmdTable::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 FlagCmd table.

void asdm::FlagCmdTable::setFromXMLFile ( const std::string &  directory)
private
void asdm::FlagCmdTable::setUnknownAttributeBinaryReader ( const std::string &  attributeName,
BinaryAttributeReaderFunctor barFctr 
)
unsigned int asdm::FlagCmdTable::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::FlagCmdTable::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 "FlagCmd.bin" or an XML representation (fileAsBin==false) will be saved in a file "FlagCmd.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::FlagCmdTableIDL* asdm::FlagCmdTable::toIDL ( )

Conversion Methods.

Convert this table into a FlagCmdTableIDL CORBA structure.

Returns
a pointer to a FlagCmdTableIDL
void asdm::FlagCmdTable::toIDL ( asdmIDL::FlagCmdTableIDL &  x) const

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

Parameters
xa reference to the asdmIDL::FlagCmdTableIDL to be populated with the content of this.
std::string asdm::FlagCmdTable::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::FlagCmdTable::toXML ( )
virtual

Produces an XML representation conform to the schema defined for FlagCmd (FlagCmdTable.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 164 of file FlagCmdTable.h.

Member Data Documentation

bool asdm::FlagCmdTable::archiveAsBin
private

Definition at line 448 of file FlagCmdTable.h.

ASDM& asdm::FlagCmdTable::container
private

Definition at line 446 of file FlagCmdTable.h.

Entity asdm::FlagCmdTable::entity
private

Definition at line 453 of file FlagCmdTable.h.

bool asdm::FlagCmdTable::fileAsBin
private

Definition at line 449 of file FlagCmdTable.h.

bool asdm::FlagCmdTable::loadInProgress
private

Load the table in memory if necessary.

Definition at line 578 of file FlagCmdTable.h.

Referenced by checkPresenceInMemory().

std::vector<FlagCmdRow * > asdm::FlagCmdTable::privateRows
private

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

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

Definition at line 502 of file FlagCmdTable.h.

std::vector<FlagCmdRow *> asdm::FlagCmdTable::row
private

Definition at line 511 of file FlagCmdTable.h.

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

Definition at line 529 of file FlagCmdTable.h.

std::string asdm::FlagCmdTable::version
private

Definition at line 451 of file FlagCmdTable.h.


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