IoT::Datapoints

class FlagsDatapointImpl

File Information

Library: IoT/Datapoints
Package: Datapoints
Header: IoT/Datapoints/FlagsDatapointImpl.h

Description

A basic implementation of an FlagsDatapoint.

Inheritance

Direct Base Classes: BasicDatapointImpl < IoT::Devices::FlagsDatapoint, FlagsDatapointImpl >

All Base Classes: BasicDatapointImpl < IoT::Devices::FlagsDatapoint, FlagsDatapointImpl >

Member Summary

Member Functions: definedFlags, flags, forceReset, forceResetFlags, getAccess, getDeviceIdentifier, getDisplayValue, getName, getSymbolicName, getType, getUpdated, invalidate, mapFlags, mapSymbolicName, mapSymbolicNames, reset, resetFlags, set, setFlags, toggle, toggleFlags, unsafeSet, unsafeToggle, unsafeUnset, unsafeUpdate, unset, unsetFlags, valid, validFlags, validValue, value

Types Aliases

Interface

using Interface = IoT::Devices::FlagsDatapoint;

Params

using Params = FlagsDatapointParams;

Constructors

FlagsDatapointImpl

FlagsDatapointImpl() = delete;

FlagsDatapointImpl

FlagsDatapointImpl(
    const std::string & id,
    const Params & params
);

Creates the ScalarDatapointImpl.

Destructor

~FlagsDatapointImpl

~FlagsDatapointImpl();

Destroys the ScalarDatapointImpl.

Member Functions

definedFlags

std::vector < IoT::Devices::FlagValue > definedFlags() const;

flags

std::vector < std::string > flags() const;

forceReset

FlagsType forceReset(
    const FlagsType & value = FlagsType ()
);

Force a reset, without performing an access check.

forceResetFlags

void forceResetFlags(
    const std::vector < std::string > & flags = std::vector < std::string > ()
);

Force a reset, without performing an access check.

invalidate

void invalidate();

reset

FlagsType reset(
    FlagsType value = FlagsType ()
);

resetFlags

void resetFlags(
    const std::vector < std::string > & flags = std::vector < std::string > ()
);

set

FlagsType set(
    FlagsType flags
);

setFlags

void setFlags(
    const std::vector < std::string > & flags
);

toggle

FlagsType toggle(
    FlagsType flags
);

toggleFlags

void toggleFlags(
    const std::vector < std::string > & flags
);

unset

FlagsType unset(
    FlagsType flags
);

unsetFlags

void unsetFlags(
    const std::vector < std::string > & flags
);

valid

bool valid() const;

validFlags

Poco::Optional < std::vector < std::string >> validFlags() const;

validValue

Poco::Optional < FlagsType > validValue() const;

value

FlagsType value() const;

getAccess protected

Poco::Any getAccess(
    const std::string & param29
) const;

getDeviceIdentifier protected

Poco::Any getDeviceIdentifier(
    const std::string & param24
) const;

getDisplayValue protected

Poco::Any getDisplayValue(
    const std::string & param23
) const;

getName protected

Poco::Any getName(
    const std::string & param25
) const;

getSymbolicName protected

Poco::Any getSymbolicName(
    const std::string & param27
) const;

getType protected

Poco::Any getType(
    const std::string & param26
) const;

getUpdated protected

Poco::Any getUpdated(
    const std::string & param28
) const;

mapFlags protected

std::vector < std::string > mapFlags(
    const FlagsType & value
) const;

mapSymbolicName protected

Poco::UInt16 mapSymbolicName(
    const std::string & symbolicName
) const;

mapSymbolicNames protected

FlagsType mapSymbolicNames(
    const std::vector < std::string > & symbolicNames
) const;

unsafeSet protected

void unsafeSet(
    const FlagsType & value
);

unsafeToggle protected

void unsafeToggle(
    const FlagsType & value
);

unsafeUnset protected

void unsafeUnset(
    const FlagsType & value
);

unsafeUpdate protected

void unsafeUpdate(
    const FlagsType & value
);

Variables

SYMBOLIC_NAME static

static const std::string SYMBOLIC_NAME;

TYPE static

static const std::string TYPE;

Securely control IoT edge devices from anywhere   Connect a Device