swarmio::services::keyvalue::Target Class Reference

Abstract base class for registered keys. More...

#include <Target.h>

Inheritance diagram for swarmio::services::keyvalue::Target:

Public Member Functions
virtual bool	CanRead (const std::string &path) const noexcept
	Determines whether the value can be read. More...
virtual bool	CanWrite (const std::string &path) const noexcept
	Determines whether the value can be written. More...
virtual data::Variant	Get (const std::string &path)=0
	Get the current value of the target. More...
virtual data::discovery::Field	GetFieldDescriptor (const std::string &path) const =0
	Get the field of the target. More...
virtual void	Set (const std::string &path, const data::Variant &value)=0
	Set the current value of the target. More...

Detailed Description

Abstract base class for registered keys.

Definition at line 12 of file Target.h.

Member Function Documentation

virtual bool swarmio::services::keyvalue::Target::CanRead ( const std::string &  path ) const

inlinevirtualnoexcept

Determines whether the value can be read.

Returns

True if Get operations are allowed

Reimplemented in swarmio::simulator::InMemoryParameter, and swarmros::bridge::ParameterTarget.

Definition at line 42 of file Target.h.

virtual bool swarmio::services::keyvalue::Target::CanWrite ( const std::string &  path ) const

inlinevirtualnoexcept

Determines whether the value can be written.

Returns

True if Set operations are allowed

Reimplemented in swarmio::simulator::InMemoryParameter, and swarmros::bridge::ParameterTarget.

Definition at line 52 of file Target.h.

virtual data::Variant swarmio::services::keyvalue::Target::Get ( const std::string &  path )

pure virtual

Get the current value of the target.

Returns

data::Variant

Implemented in swarmio::simulator::InMemoryParameter, and swarmros::bridge::ParameterTarget.

virtual data::discovery::Field swarmio::services::keyvalue::Target::GetFieldDescriptor ( const std::string &  path ) const

pure virtual

Get the field of the target.

Returns

data::discovery::Field

Implemented in swarmio::simulator::InMemoryParameter, and swarmros::bridge::ParameterTarget.

virtual void swarmio::services::keyvalue::Target::Set ( const std::string &  path, const data::Variant &  value  )

pure virtual

Set the current value of the target.

Parameters

value

New value

Implemented in swarmio::simulator::InMemoryParameter.

---

The documentation for this class was generated from the following file:

• Target.h