Attica 5.109.0
Public Types | Public Member Functions | List of all members
Attica::Event

Represents a single event. More...

#include <Attica/Event>

Public Types

typedef QList< EventList
 

Public Member Functions

 Event ()
 Creates an empty Event.
 
 Event (const Event &other)
 Copy constructor.
 
 ~Event ()
 Destructor.
 
void addExtendedAttribute (const QString &key, const QString &value)
 Add an attribute that is not included in the basis set of attributes exposed by the Event class.
 
QString city () const
 Gets the city where the Event takes place.
 
QString country () const
 Gets the country where the Event takes place.
 
QString description () const
 Gets the description of the Event.
 
QDate endDate () const
 Gets the start date of the Event.
 
QString extendedAttribute (const QString &key) const
 Get an attribute that is not included in the basis set of attributes exposed by the Event class.
 
QMap< QString, QString > extendedAttributes () const
 Get all attributes that are not included in the basis set of attributes exposed by the Event class.
 
QUrl homepage () const
 Gets the homepage of the Event.
 
QString id () const
 Gets the id of the Event.
 
bool isValid () const
 Checks whether this Event has an id.
 
qreal latitude () const
 Gets the latitude of the position the Event takes place.
 
qreal longitude () const
 Gets the longitude of the position the Event takes place.
 
QString name () const
 Gets the name of the Event.
 
Eventoperator= (const Event &other)
 Assignment operator.
 
void setCity (const QString &city)
 Sets the city where the Event takes place.
 
void setCountry (const QString &country)
 Sets the country where the Event takes place.
 
void setDescription (const QString &description)
 Sets the description of the Event.
 
void setEndDate (const QDate &endDate)
 Sets the end date of the Event.
 
void setHomepage (const QUrl &homepage)
 Sets the homepage of the Event.
 
void setId (const QString &id)
 Sets the id of the Event.
 
void setLatitude (qreal latitude)
 Sets the latitude of the position the Event takes place.
 
void setLongitude (qreal longitude)
 Sets the longitude of the position the Event takes place.
 
void setName (const QString &name)
 Sets the name of the Event.
 
void setStartDate (const QDate &startDate)
 Sets the start date of the Event.
 
void setUser (const QString &user)
 Sets the id of the user bound to the Event.
 
QDate startDate () const
 Gets the start date of the Event.
 
QString user () const
 Gets the id of the user bound to the Event.
 

Detailed Description

Represents a single event.

Constructor & Destructor Documentation

◆ Event() [1/2]

Attica::Event::Event ( )

Creates an empty Event.

◆ Event() [2/2]

Attica::Event::Event ( const Event other)

Copy constructor.

Parameters
otherthe Event to copy from

◆ ~Event()

Attica::Event::~Event ( )

Destructor.

Member Function Documentation

◆ addExtendedAttribute()

void Attica::Event::addExtendedAttribute ( const QString &  key,
const QString &  value 
)

Add an attribute that is not included in the basis set of attributes exposed by the Event class.

If the attribute already exists it gets overwritten.

Parameters
keythe key of the attribute
valuethe value of the attribute

◆ city()

QString Attica::Event::city ( ) const

Gets the city where the Event takes place.

Returns
the city

◆ country()

QString Attica::Event::country ( ) const

Gets the country where the Event takes place.

Returns
the country

◆ description()

QString Attica::Event::description ( ) const

Gets the description of the Event.

Returns
the description

◆ endDate()

QDate Attica::Event::endDate ( ) const

Gets the start date of the Event.

Returns
the end date

◆ extendedAttribute()

QString Attica::Event::extendedAttribute ( const QString &  key) const

Get an attribute that is not included in the basis set of attributes exposed by the Event class.

Parameters
keythe key of the attribute
Returns
the value of the attribute with the specified key, or an empty string, if the key has not been found

◆ extendedAttributes()

QMap< QString, QString > Attica::Event::extendedAttributes ( ) const

Get all attributes that are not included in the basis set of attributes exposed by the Event class.

Returns
the attribute mappings

◆ homepage()

QUrl Attica::Event::homepage ( ) const

Gets the homepage of the Event.

Returns
the homepage

◆ id()

QString Attica::Event::id ( ) const

Gets the id of the Event.

The id uniquely identifies a Event with the OCS API.

Returns
the id

◆ isValid()

bool Attica::Event::isValid ( ) const

Checks whether this Event has an id.

Returns
true if an id has been set, false otherwise

◆ latitude()

qreal Attica::Event::latitude ( ) const

Gets the latitude of the position the Event takes place.

Returns
the latitude

◆ longitude()

qreal Attica::Event::longitude ( ) const

Gets the longitude of the position the Event takes place.

Returns
the latitude

◆ name()

QString Attica::Event::name ( ) const

Gets the name of the Event.

Returns
the name

◆ operator=()

Event & Attica::Event::operator= ( const Event other)

Assignment operator.

Parameters
otherthe Event to assign from
Returns
pointer to this Event

◆ setCity()

void Attica::Event::setCity ( const QString &  city)

Sets the city where the Event takes place.

Parameters
citythe new city

◆ setCountry()

void Attica::Event::setCountry ( const QString &  country)

Sets the country where the Event takes place.

Parameters
countrythe new country

◆ setDescription()

void Attica::Event::setDescription ( const QString &  description)

Sets the description of the Event.

Parameters
descriptionthe new description

◆ setEndDate()

void Attica::Event::setEndDate ( const QDate &  endDate)

Sets the end date of the Event.

Parameters
endDatethe end date

◆ setHomepage()

void Attica::Event::setHomepage ( const QUrl &  homepage)

Sets the homepage of the Event.

Parameters
homepagethe new homepage

◆ setId()

void Attica::Event::setId ( const QString &  id)

Sets the id of the Event.

The id uniquely identifies a Event with the OCS API.

Parameters
idthe new id

◆ setLatitude()

void Attica::Event::setLatitude ( qreal  latitude)

Sets the latitude of the position the Event takes place.

Parameters
latitudethe new latitude

◆ setLongitude()

void Attica::Event::setLongitude ( qreal  longitude)

Sets the longitude of the position the Event takes place.

Parameters
longitudethe new latitude

◆ setName()

void Attica::Event::setName ( const QString &  name)

Sets the name of the Event.

Parameters
namethe new name

◆ setStartDate()

void Attica::Event::setStartDate ( const QDate &  startDate)

Sets the start date of the Event.

Parameters
startDatethe start date

◆ setUser()

void Attica::Event::setUser ( const QString &  user)

Sets the id of the user bound to the Event.

Parameters
userthe new user id

◆ startDate()

QDate Attica::Event::startDate ( ) const

Gets the start date of the Event.

Returns
the start date

◆ user()

QString Attica::Event::user ( ) const

Gets the id of the user bound to the Event.

Returns
the user id