• EventType
  • EventType Class

    Describes a Event for a Device. More...

    Header: #include <EventType>

    Public Functions

    EventType(const EventTypeId & id)
    QString displayName() const
    bool graphRelevant() const
    EventTypeId id() const
    int index() const
    bool isValid() const
    QString name() const
    ParamTypes paramTypes() const
    bool ruleRelevant() const
    void setDisplayName(const QString & displayName)
    void setGraphRelevant(const bool & graphRelevant)
    void setIndex(const int & index)
    void setName(const QString & name)
    void setParamTypes(const ParamTypes & paramTypes)
    void setRuleRelevant(const bool & ruleRelevant)

    Static Public Members

    QStringList mandatoryTypeProperties()
    QStringList typeProperties()

    Detailed Description

    Describes a Event for a Device.

    See also Event and EventDescriptor.

    Member Function Documentation

    EventType::EventType(const EventTypeId & id)

    Constructs a EventType object with the given id.

    QString EventType::displayName() const

    Returns the displayName of this EventType, e.g. "Temperature changed".

    See also setDisplayName().

    bool EventType::graphRelevant() const

    Returns true if this EventType is interesting to visualize the logs in a graph/chart from a user perspective.

    See also setGraphRelevant().

    EventTypeId EventType::id() const

    Returns the id.

    int EventType::index() const

    Returns the index of this EventType. The index of an EventType indicates the order in the DeviceClass. This guarantees that a Device will look always the same (Event order).

    See also setIndex().

    bool EventType::isValid() const

    Returns true if this EventType has a valid id and name

    [static] QStringList EventType::mandatoryTypeProperties()

    Returns a list of mandatory JSON properties a EventType JSON definition must have.

    QString EventType::name() const

    Returns the name of this EventType.

    See also setName().

    ParamTypes EventType::paramTypes() const

    Holds a List describing possible parameters for a Event of this EventType. e.g. QList(ParamType("temperature", QVariant::Real)).

    See also setParamTypes().

    bool EventType::ruleRelevant() const

    Returns true if this EventType is relevant for the rule from a user perspective.

    See also setRuleRelevant().

    void EventType::setDisplayName(const QString & displayName)

    Set the displayName for this EventType to displayName, e.g. "Temperature changed".

    See also displayName().

    void EventType::setGraphRelevant(const bool & graphRelevant)

    Sets this EventType graphRelevant to inform the client application if this EventType is interesting to visualize the logs in a graph/chart.

    See also graphRelevant().

    void EventType::setIndex(const int & index)

    Set the index of this EventType.

    See also index().

    void EventType::setName(const QString & name)

    Set the name for this EventType to name.

    See also name().

    void EventType::setParamTypes(const ParamTypes & paramTypes)

    Set the parameter description for this EventType to paramTypes, e.g. QList<ParamType>() << ParamType("temperature", QVariant::Real)).

    See also paramTypes().

    void EventType::setRuleRelevant(const bool & ruleRelevant)

    Sets this EventType relevant for the rule from a user perspective to ruleRelevant.

    See also ruleRelevant().

    [static] QStringList EventType::typeProperties()

    Returns a list of all valid JSON properties a EventType JSON definition can have.