Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

model::Annotation Class Reference
[The PCG model layer]

#include <Annotation.h>

List of all members.

Public Member Functions

 Annotation ()
 Annotation (int id, int score)
 Annotation (int id, int score, string name)
 ~Annotation ()
void setId (int id)
void setScore (int score)
void setName (string name)
int getId ()
int getScore ()
string getName ()
 Annotation (const Annotation &other)
Annotation & operator= (const Annotation &other)
bool operator== (const Annotation &other) const
bool operator!= (const Annotation &other) const

Private Attributes

int m_iId
int m_iScore
string m_sName

Detailed Description

Write brief comment for Annotation here.

Write detailed description for Annotation here.

Remarks:
Write remarks for Annotation here.
See also:
Separate items with the '|' character.

Definition at line 29 of file Annotation.h.

Constructor & Destructor Documentation

model::Annotation::Annotation (   )  [inline]
 

Write brief comment for Annotation here.

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Annotation here.

Remarks:
Write remarks for Annotation here.
See also:
Separate items with the '|' character.

Definition at line 51 of file Annotation.h.

Referenced by Annotation().

00051 {};

Annotation::Annotation (  int  id,
int  score
) 
 

Write brief comment for Annotation here.

Parameters:
id Description of parameter id.
score Description of parameter score.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Annotation here.

Remarks:
Write remarks for Annotation here.
See also:
Separate items with the '|' character.

Definition at line 26 of file Annotation.cpp.

References m_iId, and m_iScore.

00026                                        {
00027         m_iId = id;
00028         m_iScore = score;
00029 }

Annotation::Annotation (  int  id,
int  score,
string  name
) 
 

Write brief comment for Annotation here.

Parameters:
id Description of parameter id.
score Description of parameter score.
name Description of parameter name.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Annotation here.

Remarks:
Write remarks for Annotation here.
See also:
Separate items with the '|' character.

Definition at line 55 of file Annotation.cpp.

References Annotation(), and m_sName.

00055                                                     {
00056         Annotation(id,score);
00057         m_sName = name;
00058 }

Here is the call graph for this function:

model::Annotation::~Annotation (   )  [inline]
 

Write brief comment for ~Annotation here.

Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for ~Annotation here.

Remarks:
Write remarks for ~Annotation here.
See also:
Separate items with the '|' character.

Definition at line 69 of file Annotation.h.

00069 {};

Annotation::Annotation (  const Annotation &  other  ) 
 

Write brief comment for Annotation here.

Parameters:
other Description of parameter other.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for Annotation here.

Remarks:
Write remarks for Annotation here.
See also:
Separate items with the '|' character.

Definition at line 210 of file Annotation.cpp.

References m_iId, m_iScore, and m_sName.

00210                                               {
00211         m_iId = other.m_iId;
00212         m_iScore = other.m_iScore;
00213         m_sName = other.m_sName;
00214 }

Member Function Documentation

int Annotation::getId (   ) 
 

Write brief comment for getId here.

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for getId here.

Remarks:
Write remarks for getId here.
See also:
Separate items with the '|' character.

Definition at line 144 of file Annotation.cpp.

00144                       {
00145         return m_iId;
00146 }

string Annotation::getName (   ) 
 

Write brief comment for getName here.

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for getName here.

Remarks:
Write remarks for getName here.
See also:
Separate items with the '|' character.

Definition at line 188 of file Annotation.cpp.

00188                            {
00189         return m_sName;
00190 }

int Annotation::getScore (   ) 
 

Write brief comment for getScore here.

Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for getScore here.

Remarks:
Write remarks for getScore here.
See also:
Separate items with the '|' character.

Definition at line 166 of file Annotation.cpp.

00166                          {
00167         return m_iScore;
00168 }

bool Annotation::operator!= (  const Annotation &  other  )  const
 

Write brief comment for operator != here.

Parameters:
other Description of parameter other.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator != here.

Remarks:
Write remarks for operator != here.
See also:
Separate items with the '|' character.

Definition at line 303 of file Annotation.cpp.

References m_iId, m_iScore, and m_sName.

00304 {
00305         if( m_iId == other.m_iId
00306         && m_iScore == other.m_iScore
00307         && m_sName == other.m_sName ) {
00308         return false;
00309         }
00310     return true;
00311 }

Annotation & Annotation::operator= (  const Annotation &  other  ) 
 

Write brief comment for operator = here.

Parameters:
other Description of parameter other.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator = here.

Remarks:
Write remarks for operator = here.
See also:
Separate items with the '|' character.

Definition at line 237 of file Annotation.cpp.

References m_iId, m_iScore, and m_sName.

00238 {
00239     // if same object
00240     if ( this == &other )
00241         return *this;
00242         
00243         m_iId = other.m_iId;
00244         m_iScore = other.m_iScore;
00245         m_sName = other.m_sName;
00246         
00247     return *this;
00248 }

bool Annotation::operator== (  const Annotation &  other  )  const
 

Write brief comment for operator == here.

Parameters:
other Description of parameter other.
Returns:
Write description of return value here.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for operator == here.

Remarks:
Write remarks for operator == here.
See also:
Separate items with the '|' character.

Definition at line 271 of file Annotation.cpp.

References m_iId, m_iScore, and m_sName.

00272 {
00273 
00274     if( m_iId == other.m_iId
00275         && m_iScore == other.m_iScore
00276         && m_sName == other.m_sName ) {
00277         return true;
00278         }
00279     return false;  
00280 }

void Annotation::setId (  int  id  ) 
 

Write brief comment for setId here.

Parameters:
id Description of parameter id.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for setId here.

Remarks:
Write remarks for setId here.
See also:
Separate items with the '|' character.

Definition at line 78 of file Annotation.cpp.

References m_iId.

00078                              {
00079         m_iId = id;
00080 }

void Annotation::setName (  string  name  ) 
 

Write brief comment for setName here.

Parameters:
name Description of parameter name.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for setName here.

Remarks:
Write remarks for setName here.
See also:
Separate items with the '|' character.

Definition at line 122 of file Annotation.cpp.

References m_sName.

00122                                     {
00123         m_sName = name;
00124 }

void Annotation::setScore (  int  score  ) 
 

Write brief comment for setScore here.

Parameters:
score Description of parameter score.
Exceptions:
<exception class> Description of criteria for throwing this exception.
Write detailed description for setScore here.

Remarks:
Write remarks for setScore here.
See also:
Separate items with the '|' character.

Definition at line 100 of file Annotation.cpp.

References m_iScore.

00100                                    {
00101         m_iScore = score;
00102 }

Member Data Documentation

int model::Annotation::m_iId [private]
 

Definition at line 31 of file Annotation.h.

Referenced by Annotation(), operator!=(), operator=(), operator==(), and setId().

int model::Annotation::m_iScore [private]
 

Definition at line 32 of file Annotation.h.

Referenced by Annotation(), operator!=(), operator=(), operator==(), and setScore().

string model::Annotation::m_sName [private]
 

Definition at line 33 of file Annotation.h.

Referenced by Annotation(), operator!=(), operator=(), operator==(), and setName().

The documentation for this class was generated from the following files:
Generated on Tue Apr 17 09:39:58 2007 for PCG Library by  doxygen 1.3.9.1