cee::ug::SetInfo Class Reference

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

Public Member Functions

 SetInfo ()
 Constructs an empty object. More...
 
 SetInfo (int id, const Str &name, const Str &description)
 Constructs a new set with the specified id, name, and description. More...
 
 SetInfo (const SetInfo &other)
 Constructs a new set info that is a copy of other. More...
 
SetInfooperator= (const SetInfo &rhs)
 Assigns rhs to this set info and returns a reference to this set info. More...
 
bool operator== (const SetInfo &rhs) const
 Returns true if this object is equal to rhs. More...
 
bool operator!= (const SetInfo &rhs) const
 Returns true if this object is not equal to rhs. More...
 
Str name () const
 Returns the set name. More...
 
void setName (const Str &name)
 Sets the set name. More...
 
int id () const
 Returns the set id. More...
 
Str description () const
 Returns the set description. More...
 
void setDescription (const Str &desc)
 Sets the set description. More...
 
bool isValid () const
 Returns true if this object is a valid set info. More...
 

Detailed Description

Simple class containing metadata info for a set.

See also
DataSourceDirectory

Constructor & Destructor Documentation

cee::ug::SetInfo::SetInfo ( )

Constructs an empty object.

Default id is -1 (invalid).

cee::ug::SetInfo::SetInfo ( int  id,
const Str name,
const Str description 
)

Constructs a new set with the specified id, name, and description.

cee::ug::SetInfo::SetInfo ( const SetInfo other)

Constructs a new set info that is a copy of other.

Member Function Documentation

Str cee::ug::SetInfo::description ( ) const

Returns the set description.

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

Returns the set id.

Returns -1 if this set info object is invalid.

bool cee::ug::SetInfo::isValid ( ) const

Returns true if this object is a valid set info.

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

Returns the set name.

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

Returns true if this object is not equal to rhs.

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

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

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

Returns true if this object is equal to rhs.

void cee::ug::SetInfo::setDescription ( const Str desc)

Sets the set description.

void cee::ug::SetInfo::setName ( const Str name)

Sets the set name.