File Information
Library: IoT/Devices
Package: Generated
Header: IoT/Devices/IStringDatapoint.h
Description
The base class for datapoints holding a string value.
In addition to the methods defined in this interface, a StringDatapoint 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: StringDatapointRemoteObject
Member Summary
Member Functions: 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 < IStringDatapoint >;
Constructors
IStringDatapoint
Creates a IStringDatapoint.
Destructor
~IStringDatapoint 
virtual ~IStringDatapoint();
Destroys the IStringDatapoint.
Member Functions
isA
bool isA(
const std::type_info & otherType
) const;
Returns true if the class is a subclass of the class given by otherType.
See also: IoT::Devices::IDatapoint::isA()
remoting__enableEvents
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 const Poco::RemotingNG::Identifiable::TypeId & remoting__typeId();
Returns the TypeId of the class.
type
const std::type_info & type() const;
Returns the type information for the object's class.
See also: IoT::Devices::IDatapoint::type()
update
virtual void update(
const std::string & value
) = 0;
Updates the value of the datapoint and makes it valid.
Not all Datapoint implementations may support this method.
validValue
virtual Poco::Optional < std::string > validValue() const = 0;
Returns the current value of the datapoint if it is valid, otherwise an empty value.
value
virtual std::string 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 std::string > validated;
valueChanged
Poco::BasicEvent < const std::string > valueChanged;
valueUpdated
Poco::BasicEvent < const std::string > valueUpdated;