IoT::Devices

class IBooleanDatapoint

File Information

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

Description

The base class for datapoints holding a boolean value.

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

  • displayValue (string, optional): The current value of the datapoint, formatted as string for display purposes.

Inheritance

Direct Base Classes: IDatapoint

All Base Classes: IDatapoint, IDevice, Poco::OSP::Service, Poco::RefCountedObject

Known Derived Classes: BooleanDatapointRemoteObject

Member Summary

Member Functions: invert, isA, remoting__enableEvents, remoting__typeId, type, update, validValue, value

Inherited Functions: duplicate, getFeature, getPropertyBool, getPropertyDouble, getPropertyInt, getPropertyInt16, getPropertyInt64, getPropertyString, getPropertyTimestamp, hasFeature, hasProperty, invalidate, isA, referenceCount, release, remoting__enableEvents, remoting__typeId, setFeature, setPropertyBool, setPropertyDouble, setPropertyInt, setPropertyInt16, setPropertyInt64, setPropertyString, setPropertyTimestamp, type, valid

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < IBooleanDatapoint >;

Constructors

IBooleanDatapoint

IBooleanDatapoint();

Creates a IBooleanDatapoint.

Destructor

~IBooleanDatapoint virtual

virtual ~IBooleanDatapoint();

Destroys the IBooleanDatapoint.

Member Functions

invert virtual

virtual bool invert() = 0;

Inverts the value of the datapoint.

Returns the previous value of the datapoint.

Not all Datapoint implementations may support this method.

isA virtual

bool isA(
    const std::type_info & otherType
) const;

Returns true if the class is a subclass of the class given by otherType.

remoting__enableEvents virtual

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

Enable or disable delivery of remote events.

The given Listener instance must implement the Poco::RemotingNG::EventListener interface, otherwise this method will fail with a RemotingException.

This method is only used with Proxy objects; calling this method on a RemoteObject will do nothing.

remoting__typeId static

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

Returns the TypeId of the class.

type virtual

const std::type_info & type() const;

Returns the type information for the object's class.

update virtual

virtual bool update(
    bool value
) = 0;

Updates the value of the datapoint and makes it valid.

Returns the previous value of the datapoint.

Not all Datapoint implementations may support this method.

validValue virtual

virtual Poco::Optional < bool > validValue() const = 0;

Returns the current value of the datapoint if it is valid, otherwise an empty value.

value virtual

virtual bool value() const = 0;

Returns the current value of the datapoint, even if the datapoint has been invalidated.

Use validValue() to get a valid value only.

Variables

validated

Poco::BasicEvent < const bool > validated;

valueChanged

Poco::BasicEvent < const bool > valueChanged;

valueUpdated

Poco::BasicEvent < const bool > valueUpdated;

Securely control IoT edge devices from anywhere   Connect a Device