• TimeEventItem
  • TimeEventItem Class

    (nymeaserver::TimeEventItem)

    Describes a time event of a time based Rule. More...

    Header: #include <TimeEventItem>

    Public Functions

    TimeEventItem()
    QDateTime dateTime() const
    bool evaluate(const QDateTime & lastEvaluationTime, const QDateTime & dateTime) const
    bool isValid() const
    RepeatingOption repeatingOption() const
    void setDateTime(const int & timeStamp)
    void setRepeatingOption(const RepeatingOption & repeatingOption)
    void setTime(const QTime & time)
    QTime time() const

    Detailed Description

    Describes a time event of a time based Rule.

    See also Rule, TimeDescriptor, and CalendarItem.

    Member Function Documentation

    TimeEventItem::TimeEventItem()

    Constructs an invalid TimeEventItem.

    QDateTime TimeEventItem::dateTime() const

    Returns the dateTime of this TimeEventItem.

    See also setDateTime().

    bool TimeEventItem::evaluate(const QDateTime & lastEvaluationTime, const QDateTime & dateTime) const

    Returns true, if the given dateTime matches this TimeEventItem since the last lastEvaluationTime.

    bool TimeEventItem::isValid() const

    Returns true if this TimeEventItem is valid. A TimeEventItem is valid if either the time() or the dateTime() is set.

    RepeatingOption TimeEventItem::repeatingOption() const

    Returns the RepeatingOption of this TimeEventItem.

    See also setRepeatingOption().

    void TimeEventItem::setDateTime(const int & timeStamp)

    Sets the dateTime of this TimeEventItem to the given timeStamp.

    See also dateTime().

    void TimeEventItem::setRepeatingOption(const RepeatingOption & repeatingOption)

    Sets the repeatingOption of this TimeEventItem.

    See also repeatingOption().

    void TimeEventItem::setTime(const QTime & time)

    Sets the time of this TimeEventItem.

    See also time().

    QTime TimeEventItem::time() const

    Returns the time of this TimeEventItem.

    See also setTime().