Main Page   Namespace List   Class Hierarchy   Compound List   File List   Compound Members   File Members   Related Pages  

rnaml::Object Class Reference

#include <Object.h>

Inheritance diagram for rnaml::Object:

rnaml::Affiliation rnaml::Alignment rnaml::AlignmentId rnaml::AliSequence rnaml::Analysis rnaml::Atom rnaml::Author rnaml::Base rnaml::BaseConformation rnaml::BaseId rnaml::BaseId3p rnaml::BaseId5p rnaml::BasePair rnaml::BasePairId rnaml::BaseStack rnaml::BaseTorsionAngles rnaml::BaseTriple rnaml::BookTitle rnaml::ConsensusMolecule rnaml::DataBaseEntry rnaml::Date rnaml::DistanceConstraint rnaml::Editor rnaml::End rnaml::File rnaml::FreeEnergy rnaml::Helix rnaml::HelixId rnaml::Identity rnaml::Interactions rnaml::Issue rnaml::Journal rnaml::Length rnaml::Method rnaml::Model rnaml::ModelId rnaml::ModelInfo rnaml::Modification rnaml::Molecule rnaml::MoleculeClass rnaml::MoleculeId rnaml::NumberingRange rnaml::NumberingSystem rnaml::NumberingTable rnaml::Pages rnaml::Path rnaml::PcData rnaml::Person rnaml::ProgName rnaml::Program rnaml::ProgVersion rnaml::Pseudoknot rnaml::PubmedId rnaml::Reference rnaml::Resolution rnaml::Revision rnaml::Rnaml rnaml::SecondaryStructureDisplay rnaml::Segment rnaml::SeqAnnotation rnaml::SeqData rnaml::Sequence rnaml::SingleStrand rnaml::SsBaseCoord rnaml::StrAnnotation rnaml::Structure rnaml::SurfaceConstraint rnaml::Taxonomy rnaml::Title rnaml::Url rnaml::Volume List of all members.

Public Methods

 Object (rnamlObject *obj=0)
 Initializes the object.

 Object (const Object &right)
 Initializes the object with the right's content.

virtual ~Object ()
 Destroys the object.

virtual Object & operator= (const Object &right)
 Assigns the object with the right's content.

virtual bool operator== (const Object &right) const
 Compares the specified object with this collection for equality.

const char * getComment () const
 Gets the object comment.

void setComment (const char *comment)
 Sets the object comment.

void addReferenceId (const char *referenceId)
 Adds a reference id into the object.

std::vector< const char * > & getReferenceIds ()
 Gets the reference ids.

char * getReferenceIdsString () const
 Gets the reference ids string.

void addAnalysisId (const char *analysisId)
 Adds a analysis id into the object.

std::vector< const char * > & getAnalysisIds ()
 Gets the analysis ids.

char * getAnalysisIdsString () const
 Gets the analysis ids string.

void addDatabaseId (const char *databaseId)
 Adds a database id into the object.

std::vector< const char * > & getDatabaseIds ()
 Gets the database ids.

char * getDatabaseIdsString () const
 Gets the database ids string.

virtual const rnamlObjectgetCStructure () const
 Gets the C substructure.

virtual void setCStructure (rnamlObject *obj)
 Sets the C substructure.

virtual xmlcpgObjecttoXML () const
 Translates the Object into a xmlcpgElement conforming to the RNAML standard.


Static Protected Methods

Object * pack (rnamlObject *obj)
 Packs a rnamlObject into an appropriate object.


Private Attributes

rnamlObjectcStruct
 The rnaml C structure.

std::vector< const char * > referenceIds
 The reference ids vector.

std::vector< const char * > analysisIds
 The analysis ids vector.

std::vector< const char * > databaseIds
 The database ids vector.


Constructor & Destructor Documentation

rnaml::Object::Object rnamlObject   obj = 0
 

Initializes the object.

rnaml::Object::Object const Object &    right
 

Initializes the object with the right's content.

Parameters:
right  the object to copy.

rnaml::Object::~Object   [virtual]
 

Destroys the object.


Member Function Documentation

void rnaml::Object::addAnalysisId const char *    analysisId
 

Adds a analysis id into the object.

Parameters:
analysisId  the analysis id string.

void rnaml::Object::addDatabaseId const char *    databaseId
 

Adds a database id into the object.

Parameters:
databaseId  the database id string.

void rnaml::Object::addReferenceId const char *    referenceId
 

Adds a reference id into the object.

Parameters:
referenceId  the reference id string.

std::vector< const char* >& rnaml::Object::getAnalysisIds   [inline]
 

Gets the analysis ids.

Returns:
the analysis-ids vector.

char* rnaml::Object::getAnalysisIdsString   const [inline]
 

Gets the analysis ids string.

An empty string is returned if no analysis ids are present in the object.

Returns:
the analysis ids string or 0.

const char* rnaml::Object::getComment   const [inline]
 

Gets the object comment.

Returns:
the object comment string or 0.

virtual const rnamlObject* rnaml::Object::getCStructure   const [inline, virtual]
 

Gets the C substructure.

Returns:
the C substructure.

std::vector< const char* >& rnaml::Object::getDatabaseIds   [inline]
 

Gets the database ids.

Returns:
the database-ids vector.

char* rnaml::Object::getDatabaseIdsString   const [inline]
 

Gets the database ids string.

An empty string is returned if no database ids are present in the object.

Returns:
the database ids string or 0.

std::vector< const char* >& rnaml::Object::getReferenceIds   [inline]
 

Gets the reference ids.

Returns:
the reference-ids vector.

char* rnaml::Object::getReferenceIdsString   const [inline]
 

Gets the reference ids string.

An empty string is returned if no reference ids are present in the object.

Returns:
the reference ids string or 0.

Object & rnaml::Object::operator= const Object &    right [virtual]
 

Assigns the object with the right's content.

Parameters:
right  the object to copy.
Returns:
itself.

bool rnaml::Object::operator== const Object &    right const [virtual]
 

Compares the specified object with this collection for equality.

Parameters:
right  Object to be compared for equality with this object.
Returns:
true if the specified object is equal to this.

Object * rnaml::Object::pack rnamlObject   obj [static, protected]
 

Packs a rnamlObject into an appropriate object.

Parameters:
obj  the rnamlObject to pack.
Returns:
a new Object containing obj.

void rnaml::Object::setComment const char *    comment [inline]
 

Sets the object comment.

Parameters:
comment  the object comment string.

void rnaml::Object::setCStructure rnamlObject   obj [virtual]
 

Sets the C substructure.

Parameters:
obj  the C substructure.

Reimplemented in rnaml::Alignment, rnaml::Analysis, rnaml::Base, rnaml::Interactions, rnaml::Model, rnaml::ModelInfo, rnaml::Molecule, rnaml::MoleculeClass, rnaml::NumberingSystem, rnaml::NumberingTable, rnaml::Person, rnaml::Program, rnaml::Reference, rnaml::Revision, rnaml::Rnaml, rnaml::SecondaryStructureDisplay, rnaml::SeqAnnotation, rnaml::Sequence, rnaml::StrAnnotation, and rnaml::Structure.

virtual xmlcpgObject* rnaml::Object::toXML   const [inline, virtual]
 

Translates the Object into a xmlcpgElement conforming to the RNAML standard.

Returns:
the xmlcpgObject or 0 if something goes wrong.


Member Data Documentation

std::vector< const char* > rnaml::Object::analysisIds [private]
 

The analysis ids vector.

rnamlObject* rnaml::Object::cStruct [private]
 

The rnaml C structure.

std::vector< const char* > rnaml::Object::databaseIds [private]
 

The database ids vector.

std::vector< const char* > rnaml::Object::referenceIds [private]
 

The reference ids vector.


The documentation for this class was generated from the following files:
Generated on Tue Nov 11 14:59:56 2003 for xmlcpg by doxygen1.2.18