• Action
  • Action Class

    Holds information required to execute an action described by a ActionType. More...

    Header: #include <Action>

    Public Functions

    Action(const ActionTypeId & actionTypeId = ActionTypeId(), const DeviceId & deviceId = DeviceId())
    Action(const Action & other)
    ActionTypeId actionTypeId() const
    DeviceId deviceId() const
    ActionId id() const
    bool isValid() const
    Param param(const ParamTypeId & paramTypeId) const
    ParamList params() const
    void setParams(const ParamList & params)
    void operator=(const Action & other)

    Detailed Description

    Holds information required to execute an action described by a ActionType.

    It is bound to a Device and an ActionType and holds the parameters for the execution of the action.

    The params must match the template as described in ActionType.

    See also Device and ActionType.

    Member Function Documentation

    Action::Action(const ActionTypeId & actionTypeId = ActionTypeId(), const DeviceId & deviceId = DeviceId())

    Construct an Action with the given deviceId and actionTypeId.

    Action::Action(const Action & other)

    Construct a copy of an other Action.

    ActionTypeId Action::actionTypeId() const

    Returns the actionTypeId for this Action.

    DeviceId Action::deviceId() const

    Returns the deviceId this Action is associated with.

    ActionId Action::id() const

    Returns the actionId for this Action.

    bool Action::isValid() const

    An Action is valid if actionTypeId and deviceId are valid uuids. Returns true if valid, false if not.

    Param Action::param(const ParamTypeId & paramTypeId) const

    Returns the parameter of this Action with a cetrain paramTypeId.

    ParamList Action::params() const

    Returns the parameters for this Action.

    See also setParams().

    void Action::setParams(const ParamList & params)

    Set the parameters for this Action. params must match the template in the ActionType referred by Action::actionTypeId().

    See also params().

    void Action::operator=(const Action & other)

    Copy the data to an Action from an other action.