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

#include <PulsarTable.h>

Inheritance diagram for asdm::PulsarTable:

Public Member Functions
virtual	~PulsarTable ()

ASDM &	getContainer () 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 Pulsar (PulsarTable.xsd). More...

asdmIDL::PulsarTableIDL *	toIDL ()
	Conversion Methods. More...

void	toIDL (asdmIDL::PulsarTableIDL &x) const
	Fills the CORBA data structure passed in parameter with the content of this table. More...

void	fromIDL (asdmIDL::PulsarTableIDL x)
	Populate this table from the content of a PulsarTableIDL Corba structure. More...

PulsarRow *	newRow ()
	====> Row creation. More...

PulsarRow *	newRow (ArrayTime refTime, Frequency refPulseFreq, double refPhase, int numBin)
	Create a new row initialized to the specified values. More...

PulsarRow *	newRow (PulsarRow *row)
	Create a new row using a copy constructor mechanism. More...

PulsarRow *	add (PulsarRow *x)
	====> Append a row to its table. More...

std::vector< PulsarRow * >	get ()
	====> Methods returning rows. More...

const std::vector< PulsarRow * > &	get () const
	Get a const reference on the collection of rows pointers internally hold by the table. More...

PulsarRow *	getRowByKey (Tag pulsarId)
	Returns a PulsarRow* given a key. More...

PulsarRow *	lookup (ArrayTime refTime, Frequency refPulseFreq, double refPhase, int numBin)
	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)

BinaryAttributeReaderFunctor *	getUnknownAttributeBinaryReader (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
	PulsarTable (ASDM &container)
	Create a PulsarTable. More...

void	autoIncrement (std::string key, PulsarRow *x)

PulsarRow *	checkAndAdd (PulsarRow *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 (PulsarRow *x)
	Brutally append an PulsarRow x to the collection of rows already stored in this table. More...

void	addWithoutCheckingUnique (PulsarRow *x)
	Brutally append an PulsarRow 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 Pulsar (PulsarTable.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 Pulsar 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 PulsarTable as those produced by the toFile method. More...

Private Attributes
ASDM &	container

bool	archiveAsBin

bool	fileAsBin

std::string	version

Entity	entity

std::map< std::string, int >	noAutoIncIds
	A map for the autoincrementation algorithm. More...

std::vector< PulsarRow * >	privateRows
	A data structure to store the pointers on the table's rows. More...

std::vector< PulsarRow * >	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 PulsarTable class is an Alma table.

Role: Polarization information.

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

Attributes of Pulsar
Name	Type	Expected shape	Comment
Key
pulsarId	Tag		Pulsar Table identifier
Value (Mandatory)
refTime	ArrayTime		Reference time for a polynomial
refPulseFreq	Frequency		Reference pulse frequency
refPhase	double		Reference pulse phase (turns)
numBin (numBin)	int		Number of phase bins
Value (Optional)
numPoly(numPoly)	int		Number of polynomial coefficients
phasePoly	std::vector<double >	numPoly	The phase polynomial coefficients (Tempo units)
timeSpan	Interval		Time range over which the polynomial is valid
startPhaseBin	std::vector<float >	numBin	Start phase for each bin (turns)
endPhaseBin	std::vector<float >	numBin	End phase for each bin (turns)
dispersionMeasure	double		Dispersion measure applied, if data have been dedispersed (pc cm?3 )
refFrequency	Frequency		Reference radio frequency for dedispersion

Definition at line 224 of file PulsarTable.h.

Constructor & Destructor Documentation

virtual asdm::PulsarTable::~PulsarTable ( )

virtual

asdm::PulsarTable::PulsarTable ( ASDM & container )

private

Create a PulsarTable.

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

Parameters

container The container to which this table belongs.

Member Function Documentation

PulsarRow* asdm::PulsarTable::add ( PulsarRow * 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 PulsarRow.

void asdm::PulsarTable::addWithoutCheckingUnique ( PulsarRow * x )

private

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

No uniqueness check is done !

Parameters

PulsarRow* x a pointer onto the PulsarRow to be appended.

void asdm::PulsarTable::append ( PulsarRow * x )

private

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

No uniqueness check is done !

Parameters

PulsarRow* x a pointer onto the PulsarRow to be appended.

void asdm::PulsarTable::autoIncrement	(	std::string	key,
		PulsarRow *	x
	)

private

PulsarRow* asdm::PulsarTable::checkAndAdd	(	PulsarRow *	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::PulsarTable::checkPresenceInMemory ( )

inlineprivate

Definition at line 593 of file PulsarTable.h.

References getContainer(), loadInProgress, asdm::Representable::presentInMemory, and setFromFile().

static const std::vector<std::string>& asdm::PulsarTable::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::PulsarTable::error ( )

private

void asdm::PulsarTable::fromIDL ( asdmIDL::PulsarTableIDL x )

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

Exceptions

DuplicateKey	Thrown if the method tries to add a row having a key that is already in the table.
ConversionException

void asdm::PulsarTable::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 Pulsar (PulsarTable.xsd).

Exceptions

ConversionException

Implements asdm::Representable.

std::vector<PulsarRow *> asdm::PulsarTable::get ( )

====> Methods returning rows.

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

Returns: Alls rows in a vector of pointers of PulsarRow. The elements of this vector are stored in the order in which they have been added to the PulsarTable.

const std::vector<PulsarRow *>& asdm::PulsarTable::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 PulsarRow. The elements of this vector are stored in the order in which they have been added to the PulsarTable.

static const std::vector<std::string>& asdm::PulsarTable::getAttributesNames ( )

static

Return the names of the attributes of this table.

Returns: a vector of string

ASDM& asdm::PulsarTable::getContainer ( ) const

Return the container to which this table belongs.

Returns: the ASDM containing this table.

Referenced by checkPresenceInMemory().

Entity asdm::PulsarTable::getEntity ( ) const

virtual

Return this table's Entity.

Implements asdm::Representable.

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

PulsarRow* asdm::PulsarTable::getRowByKey ( Tag pulsarId )

Returns a PulsarRow* 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

pulsarId

BinaryAttributeReaderFunctor* asdm::PulsarTable::getUnknownAttributeBinaryReader ( const std::string & attributeName ) const

std::string asdm::PulsarTable::getVersion ( ) const

Return the version information about this table.

PulsarRow* asdm::PulsarTable::lookup	(	ArrayTime	refTime,
		Frequency	refPulseFreq,
		double	refPhase,
		int	numBin
	)

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

refTime
refPulseFreq
refPhase
numBin

std::string asdm::PulsarTable::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::PulsarTable::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.

PulsarRow* asdm::PulsarTable::newRow ( )

====> Row creation.

Create a new row with default values.

Returns: a pointer on a PulsarRow

PulsarRow* asdm::PulsarTable::newRow	(	ArrayTime	refTime,
		Frequency	refPulseFreq,
		double	refPhase,
		int	numBin
	)

Create a new row initialized to the specified values.

Returns: a pointer on the created and initialized row.

Parameters

refTime
refPulseFreq
refPhase
numBin

PulsarRow* asdm::PulsarTable::newRow ( PulsarRow * row )

Create a new row using a copy constructor mechanism.

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

Parameters

row	the row which is to be copied.

void asdm::PulsarTable::setEntity ( Entity e )

virtual

Set this table's Entity.

Parameters

e	An entity.

Implements asdm::Representable.

void asdm::PulsarTable::setFromFile ( const std::string & directory )

private

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

This table is populated with the result of the parsing.

Parameters

directory The name of the directory containing the file te be read and parsed.

Exceptions

ConversionException If any error occurs while reading the files in the directory or parsing them.

Referenced by checkPresenceInMemory().

void asdm::PulsarTable::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

mimeMsg the string containing the MIME message.

Exceptions

ConversionException

void asdm::PulsarTable::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 Pulsar table.

void asdm::PulsarTable::setFromXMLFile ( const std::string & directory )

private

void asdm::PulsarTable::setUnknownAttributeBinaryReader	(	const std::string &	attributeName,
		BinaryAttributeReaderFunctor *	barFctr
	)

unsigned int asdm::PulsarTable::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::PulsarTable::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 "Pulsar.bin" or an XML representation (fileAsBin==false) will be saved in a file "Pulsar.xml". The file is always written in a directory whose name is passed as a parameter.

Parameters

directory The name of directory where the file containing the table's representation will be saved.

asdmIDL::PulsarTableIDL* asdm::PulsarTable::toIDL ( )

Conversion Methods.

Convert this table into a PulsarTableIDL CORBA structure.

Returns: a pointer to a PulsarTableIDL

void asdm::PulsarTable::toIDL ( asdmIDL::PulsarTableIDL & x ) const

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

Parameters

x	a reference to the asdmIDL::PulsarTableIDL to be populated with the content of this.

std::string asdm::PulsarTable::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

byteOrder a const pointer to a static instance of the class ByteOrder.

std::string asdm::PulsarTable::toXML ( )

virtual

Produces an XML representation conform to the schema defined for Pulsar (PulsarTable.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 225 of file PulsarTable.h.

Member Data Documentation

bool asdm::PulsarTable::archiveAsBin

private

Definition at line 477 of file PulsarTable.h.

ASDM& asdm::PulsarTable::container

private

Definition at line 475 of file PulsarTable.h.

Entity asdm::PulsarTable::entity

private

Definition at line 482 of file PulsarTable.h.

bool asdm::PulsarTable::fileAsBin

private

Definition at line 478 of file PulsarTable.h.

bool asdm::PulsarTable::loadInProgress

private

Load the table in memory if necessary.

Definition at line 592 of file PulsarTable.h.

Referenced by checkPresenceInMemory().

std::map<std::string,int> asdm::PulsarTable::noAutoIncIds

private

A map for the autoincrementation algorithm.

Definition at line 489 of file PulsarTable.h.

std::vector<PulsarRow * > asdm::PulsarTable::privateRows

private

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

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

Definition at line 525 of file PulsarTable.h.

std::vector<PulsarRow *> asdm::PulsarTable::row

private

Definition at line 529 of file PulsarTable.h.

std::map<std::string, BinaryAttributeReaderFunctor *> asdm::PulsarTable::unknownAttributes2Functors

private

Definition at line 543 of file PulsarTable.h.

std::string asdm::PulsarTable::version

private

Definition at line 480 of file PulsarTable.h.

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

casa/code/alma/ASDM/PulsarTable.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation