• RuleActionParam
  • RuleActionParam Class

    Holds the parameters for a RuleAction. More...

    Header: #include <RuleActionParam>

    Public Functions

    RuleActionParam(const Param & param = Param())
    RuleActionParam(const ParamTypeId & paramTypeId, const QVariant & value = QVariant(), const EventTypeId & eventTypeId = EventTypeId(), const ParamTypeId & eventParamTypeId = ParamTypeId())
    RuleActionParam(const QString & paramName, const QVariant & value = QVariant(), const EventTypeId & eventTypeId = EventTypeId(), const ParamTypeId & eventParamTypeId = ParamTypeId())
    ParamTypeId eventParamTypeId() const
    EventTypeId eventTypeId() const
    bool isValid() const
    QString paramName() const
    ParamTypeId paramTypeId() const
    void setEventParamTypeId(const ParamTypeId & eventParamTypeId)
    void setEventTypeId(const EventTypeId & eventTypeId)
    void setValue(const QVariant & value)
    QVariant value() const

    Detailed Description

    Holds the parameters for a RuleAction.

    A RuleActionParam allows rules to take over an Event parameter into a rule RuleAction.

    See also nymeaserver::Rule and RuleAction.

    Member Function Documentation

    RuleActionParam::RuleActionParam(const Param & param = Param())

    Constructs a RuleActionParam with the given param.

    See also Param.

    RuleActionParam::RuleActionParam(const ParamTypeId & paramTypeId, const QVariant & value = QVariant(), const EventTypeId & eventTypeId = EventTypeId(), const ParamTypeId & eventParamTypeId = ParamTypeId())

    Constructs a RuleActionParam with the given paramTypeId, value, eventTypeId and eventParamTypeId.

    See also Param and Event.

    RuleActionParam::RuleActionParam(const QString & paramName, const QVariant & value = QVariant(), const EventTypeId & eventTypeId = EventTypeId(), const ParamTypeId & eventParamTypeId = ParamTypeId())

    Constructs a RuleActionParam with the given paramName, value, eventTypeId and eventParamTypeId.

    See also Param and Event.

    ParamTypeId RuleActionParam::eventParamTypeId() const

    Returns the eventParamTypeId of this RuleActionParam.

    See also setEventParamTypeId().

    EventTypeId RuleActionParam::eventTypeId() const

    Return the EventTypeId of the Event with the Param which will be taken over in the RuleAction.

    See also setEventTypeId().

    bool RuleActionParam::isValid() const

    Returns true if the (paramTypeId AND value) XOR (paramTypeId AND eventTypeId AND eventParamName) of this RuleActionParam are set.

    QString RuleActionParam::paramName() const

    Returns the name of this RuleActionParam.

    ParamTypeId RuleActionParam::paramTypeId() const

    Returns the ParamTypeId of this RuleActionParam.

    void RuleActionParam::setEventParamTypeId(const ParamTypeId & eventParamTypeId)

    Sets the eventParamTypeId of this RuleActionParam.

    See also eventParamTypeId().

    void RuleActionParam::setEventTypeId(const EventTypeId & eventTypeId)

    Sets the eventTypeId of the Event with the Param which will be taken over in the RuleAction.

    See also eventTypeId().

    void RuleActionParam::setValue(const QVariant & value)

    Sets the value of this RuleActionParam.

    See also value().

    QVariant RuleActionParam::value() const

    Returns the value of this RuleActionParam.

    See also setValue().