• CalendarItem
  • CalendarItem Class

    (nymeaserver::CalendarItem)

    Describes a clendar item for a time based Rule. More...

    Header: #include <CalendarItem>

    Public Functions

    CalendarItem()
    QDateTime dateTime() const
    uint duration() const
    bool evaluate(const QDateTime & dateTime) const
    bool isValid() const
    RepeatingOption repeatingOption() const
    void setDateTime(const QDateTime & dateTime)
    void setDuration(const uint & duration)
    void setRepeatingOption(const RepeatingOption & repeatingOption)
    void setStartTime(const QTime & startTime)
    QTime startTime() const

    Detailed Description

    Describes a clendar item for a time based Rule.

    See also Rule and TimeDescriptor.

    Member Function Documentation

    CalendarItem::CalendarItem()

    Construct a invalid CalendarItem.

    QDateTime CalendarItem::dateTime() const

    Returns the date time of this CalendarItem.

    See also setDateTime().

    uint CalendarItem::duration() const

    Returns the duratiorn of this CalendarItem.

    See also setDuration().

    bool CalendarItem::evaluate(const QDateTime & dateTime) const

    Returns true, if the given dateTime matches this CalendarItem.

    bool CalendarItem::isValid() const

    Returns true if this CalendarItem is valid. A CalendarItem is invalid if start time and datetime are set or if the duration is 0.

    RepeatingOption CalendarItem::repeatingOption() const

    Returns the RepeatingOption of this CalendarItem.

    See also setRepeatingOption().

    void CalendarItem::setDateTime(const QDateTime & dateTime)

    Sets the dateTime of this CalendarItem.

    See also dateTime().

    void CalendarItem::setDuration(const uint & duration)

    Sets the duration of this CalendarItem.

    See also duration().

    void CalendarItem::setRepeatingOption(const RepeatingOption & repeatingOption)

    Sets the repeatingOption of this CalendarItem.

    See also repeatingOption().

    void CalendarItem::setStartTime(const QTime & startTime)

    Sets the startTime of this CalendarItem.

    See also startTime().

    QTime CalendarItem::startTime() const

    Returns the start time of this CalendarItem.

    See also setStartTime().