cee::ug::SectionGroupInfo Class Reference

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

Public Member Functions

 SectionGroupInfo ()
 Constructs an empty object. More...
 
 SectionGroupInfo (int id, const Str &name, const std::vector< int > &sectionIds)
 Constructs a new object with the given section group id, name and section ids. More...
 
 SectionGroupInfo (const SectionGroupInfo &other)
 Constructs a new SectionGroupInfo that is a copy of other. More...
 
SectionGroupInfooperator= (const SectionGroupInfo &rhs)
 Assigns rhs to this section info and returns a reference to this section group info. More...
 
bool operator== (const SectionGroupInfo &rhs) const
 Returns true if this object is equal to rhs. More...
 
bool operator!= (const SectionGroupInfo &rhs) const
 Returns true if this object is not equal to rhs. More...
 
int id () const
 Returns the section group id. More...
 
Str name () const
 Returns the section group name. More...
 
std::vector< int > sectionIds () const
 Returns the section ids conforming this section group. More...
 

Detailed Description

Simple class containing metadata info for a section Group.

A section group info contains:

  • Section group id
  • Section group name
  • List of Section Info ids conforming the group

If there are more than 1 section, we will create Top and Bottom group and pick the default sections for each category. This can be changed in the ReaderSettings.

Constructor & Destructor Documentation

cee::ug::SectionGroupInfo::SectionGroupInfo ( )

Constructs an empty object.

Default id is -1 (invalid)

cee::ug::SectionGroupInfo::SectionGroupInfo ( int  id,
const Str name,
const std::vector< int > &  sectionIds 
)

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

cee::ug::SectionGroupInfo::SectionGroupInfo ( const SectionGroupInfo other)

Constructs a new SectionGroupInfo that is a copy of other.

Member Function Documentation

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

Returns the section group id.

Returns -1 if this section category info object is invalid.

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

Returns the section group name.

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

Returns true if this object is not equal to rhs.

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

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

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

Returns true if this object is equal to rhs.

std::vector< int > cee::ug::SectionGroupInfo::sectionIds ( ) const

Returns the section ids conforming this section group.