cee::ug::SectionInfo Class Reference

Simple class containing metadata info for a section. More...

Public Member Functions

 SectionInfo ()
 Constructs an empty object. More...
 
 SectionInfo (int id, const Str &name, int categoryId)
 Constructs a new object with the given section id and name. More...
 
 SectionInfo (const SectionInfo &other)
 Constructs a new SectionInfo that is a copy of other. More...
 
SectionInfooperator= (const SectionInfo &rhs)
 Assigns rhs to this section info and returns a reference to this section info. More...
 
bool operator== (const SectionInfo &rhs) const
 Returns true if this object is equal to rhs. More...
 
bool operator!= (const SectionInfo &rhs) const
 Returns true if this object is not equal to rhs. More...
 
int id () const
 Returns the section id. More...
 
Str name () const
 Returns the section name. More...
 
int categoryId () const
 Returns the section category id. More...
 

Detailed Description

Simple class containing metadata info for a section.

A state group info contains:

  • Section id
  • Section name

Constructor & Destructor Documentation

cee::ug::SectionInfo::SectionInfo ( )

Constructs an empty object.

Default id is -1 (invalid)

cee::ug::SectionInfo::SectionInfo ( int  id,
const Str name,
int  categoryId 
)

Constructs a new object with the given section id and name.

cee::ug::SectionInfo::SectionInfo ( const SectionInfo other)

Constructs a new SectionInfo that is a copy of other.

Member Function Documentation

int cee::ug::SectionInfo::categoryId ( ) const

Returns the section category id.

Returns -1 if this section info object is invalid.

int cee::ug::SectionInfo::id ( ) const

Returns the section id.

Returns -1 if this section info object is invalid.

Str cee::ug::SectionInfo::name ( ) const

Returns the section name.

bool cee::ug::SectionInfo::operator!= ( const SectionInfo rhs) const

Returns true if this object is not equal to rhs.

SectionInfo & cee::ug::SectionInfo::operator= ( const SectionInfo rhs)

Assigns rhs to this section info and returns a reference to this section info.

bool cee::ug::SectionInfo::operator== ( const SectionInfo rhs) const

Returns true if this object is equal to rhs.