IoT::Devices

class IMagnetometer

File Information

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

Description

The interface for three-axis Magnetometers.

Inheritance

Direct Base Classes: IDevice

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

Known Derived Classes: MagnetometerRemoteObject

Member Summary

Member Functions: fieldStrength, isA, remoting__enableEvents, remoting__typeId, type

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

Types Aliases

Ptr

using Ptr = Poco::AutoPtr < IMagnetometer >;

Constructors

IMagnetometer

IMagnetometer();

Creates a IMagnetometer.

Destructor

~IMagnetometer virtual

virtual ~IMagnetometer();

Destroys the IMagnetometer.

Member Functions

fieldStrength virtual

virtual IoT::Devices::MagneticFieldStrength fieldStrength() const = 0;

Returns the most recently measured field strength values.

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.

Variables

fieldStrengthChanged

Poco::BasicEvent < const IoT::Devices::MagneticFieldStrength > fieldStrengthChanged;

Securely control IoT edge devices from anywhere   Connect a Device