IoT::Devices

class SwitchRemoteObject

File Information

Library: IoT/Devices
Package: Generated
Header: IoT/Devices/SwitchRemoteObject.h

Description

The base class for switchable things (that can be turned on and off).

A Switch has a current state and a target state. Depending upon the implementation, the current state and target state may be different for a short amount of time (e.g., while the device is powering on).

In addition to the methods defined in this interface, a Switch implementation should expose the following properties:

  • displayState (string, optional): The current state of the Switch, formatted as string for display purposes.

Inheritance

Direct Base Classes: ISwitch, Poco::RemotingNG::RemoteObject

All Base Classes: IDevice, ISwitch, Poco::OSP::Service, Poco::RefCountedObject, Poco::RemotingNG::Identifiable, Poco::RemotingNG::RemoteObject

Member Summary

Member Functions: event__stateChanged, event__statusChanged, getFeature, getPropertyBool, getPropertyDouble, getPropertyInt, getPropertyInt16, getPropertyInt64, getPropertyString, getPropertyTimestamp, getTargetState, hasFeature, hasProperty, remoting__enableEvents, remoting__enableRemoteEvents, remoting__hasEvents, remoting__typeId, setFeature, setPropertyBool, setPropertyDouble, setPropertyInt, setPropertyInt16, setPropertyInt64, setPropertyString, setPropertyTimestamp, setTargetState, state

Inherited Functions: duplicate, getFeature, getPropertyBool, getPropertyDouble, getPropertyInt, getPropertyInt16, getPropertyInt64, getPropertyString, getPropertyTimestamp, getTargetState, hasFeature, hasProperty, isA, mutex, referenceCount, release, remoting__enableEvents, remoting__enableRemoteEvents, remoting__getURI, remoting__hasEvents, remoting__objectId, remoting__setURI, remoting__typeId, setFeature, setPropertyBool, setPropertyDouble, setPropertyInt, setPropertyInt16, setPropertyInt64, setPropertyString, setPropertyTimestamp, setTargetState, state, type

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < SwitchRemoteObject >;

Constructors

SwitchRemoteObject

SwitchRemoteObject(
    const Poco::RemotingNG::Identifiable::ObjectId & oid,
    Poco::SharedPtr < IoT::Devices::Switch > pServiceObject
);

Creates a SwitchRemoteObject.

Destructor

~SwitchRemoteObject virtual

virtual ~SwitchRemoteObject();

Destroys the SwitchRemoteObject.

Member Functions

getFeature virtual inline

virtual bool getFeature(
    const std::string & name
) const;

Returns true if the feature with the given name is enabled, or false otherwise.

See also: IoT::Devices::IDevice::getFeature()

getPropertyBool virtual inline

virtual bool getPropertyBool(
    const std::string & name
) const;

Returns the value of the device property with the given name.

Throws a Poco::NotFoundException if the property with the given name is unknown.

See also: IoT::Devices::IDevice::getPropertyBool()

getPropertyDouble virtual inline

virtual double getPropertyDouble(
    const std::string & name
) const;

Returns the value of the device property with the given name.

Throws a Poco::NotFoundException if the property with the given name is unknown.

See also: IoT::Devices::IDevice::getPropertyDouble()

getPropertyInt virtual inline

virtual int getPropertyInt(
    const std::string & name
) const;

Returns the value of the device property with the given name.

Throws a Poco::NotFoundException if the property with the given name is unknown.

See also: IoT::Devices::IDevice::getPropertyInt()

getPropertyInt16 virtual inline

virtual Poco::Int16 getPropertyInt16(
    const std::string & name
) const;

Returns the value of the device property with the given name.

Throws a Poco::NotFoundException if the property with the given name is unknown.

See also: IoT::Devices::IDevice::getPropertyInt16()

getPropertyInt64 virtual inline

virtual Poco::Int64 getPropertyInt64(
    const std::string & name
) const;

Returns the value of the device property with the given name.

Throws a Poco::NotFoundException if the property with the given name is unknown.

See also: IoT::Devices::IDevice::getPropertyInt64()

getPropertyString virtual inline

virtual std::string getPropertyString(
    const std::string & name
) const;

Returns the value of the device property with the given name.

Throws a Poco::NotFoundException if the property with the given name is unknown.

See also: IoT::Devices::IDevice::getPropertyString()

getPropertyTimestamp virtual inline

virtual Poco::Timestamp getPropertyTimestamp(
    const std::string & name
) const;

Returns the value of the device property with the given name.

Throws a Poco::NotFoundException if the property with the given name is unknown.

See also: IoT::Devices::IDevice::getPropertyTimestamp()

getTargetState virtual inline

virtual bool getTargetState() const;

Returns the target state of the Switch.

See also: IoT::Devices::ISwitch::getTargetState()

hasFeature virtual inline

virtual bool hasFeature(
    const std::string & name
) const;

Returns true if the feature with the given name is known, or false otherwise.

See also: IoT::Devices::IDevice::hasFeature()

hasProperty virtual inline

virtual bool hasProperty(
    const std::string & name
) const;

Returns true if the property with the given name exists, or false otherwise.

See also: IoT::Devices::IDevice::hasProperty()

remoting__enableEvents virtual

virtual std::string remoting__enableEvents(
    Poco::RemotingNG::Listener::Ptr pListener,
    bool enable = bool (true)
);

See also: IoT::Devices::ISwitch::remoting__enableEvents()

remoting__enableRemoteEvents virtual

virtual void remoting__enableRemoteEvents(
    const std::string & protocol
);

See also: Poco::RemotingNG::RemoteObject::remoting__enableRemoteEvents()

remoting__hasEvents virtual

virtual bool remoting__hasEvents() const;

See also: Poco::RemotingNG::RemoteObject::remoting__hasEvents()

remoting__typeId virtual inline

virtual const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId() const;

setFeature virtual inline

virtual void setFeature(
    const std::string & name,
    bool enable
);

Enables or disables the feature with the given name.

Which features are supported is defined by the actual device implementation.

See also: IoT::Devices::IDevice::setFeature()

setPropertyBool virtual inline

virtual void setPropertyBool(
    const std::string & name,
    bool value
);

Sets a device property.

Which properties are supported is defined by the actual device implementation.

See also: IoT::Devices::IDevice::setPropertyBool()

setPropertyDouble virtual inline

virtual void setPropertyDouble(
    const std::string & name,
    double value
);

Sets a device property.

Which properties are supported is defined by the actual device implementation.

See also: IoT::Devices::IDevice::setPropertyDouble()

setPropertyInt virtual inline

virtual void setPropertyInt(
    const std::string & name,
    int value
);

Sets a device property.

Which properties are supported is defined by the actual device implementation.

See also: IoT::Devices::IDevice::setPropertyInt()

setPropertyInt16 virtual inline

virtual void setPropertyInt16(
    const std::string & name,
    Poco::Int16 value
);

Sets a device property.

Which properties are supported is defined by the actual device implementation.

See also: IoT::Devices::IDevice::setPropertyInt16()

setPropertyInt64 virtual inline

virtual void setPropertyInt64(
    const std::string & name,
    Poco::Int64 value
);

Sets a device property.

Which properties are supported is defined by the actual device implementation.

See also: IoT::Devices::IDevice::setPropertyInt64()

setPropertyString virtual inline

virtual void setPropertyString(
    const std::string & name,
    const std::string & value
);

Sets a device property.

Which properties are supported is defined by the actual device implementation.

See also: IoT::Devices::IDevice::setPropertyString()

setPropertyTimestamp virtual inline

virtual void setPropertyTimestamp(
    const std::string & name,
    Poco::Timestamp value
);

Sets a device property.

Which properties are supported is defined by the actual device implementation.

See also: IoT::Devices::IDevice::setPropertyTimestamp()

setTargetState virtual inline

virtual void setTargetState(
    bool newState
);

Sets the target state of the Switch.

See also: IoT::Devices::ISwitch::setTargetState()

state virtual inline

virtual bool state() const;

Returns the current state of the Switch.

See also: IoT::Devices::ISwitch::state()

event__stateChanged protected

void event__stateChanged(
    const bool & data
);

event__statusChanged protected

void event__statusChanged(
    const IoT::Devices::DeviceStatusChange & data
);

Securely control IoT edge devices from anywhere   Connect a Device