kDB: Knowledge DataBase
Loading...
Searching...
No Matches
kDBRobotics::Agent Class Reference

#include <Agent.h>

Classes

struct  Private
 

Public Member Functions

 Agent ()
 
 Agent (const Agent &_rhs)
 
Agentoperator= (const Agent &_rhs)
 
knowCore::Uri uri () const
 
knowCore::Uri type () const
 
QString name () const
 
knowCore::ReturnVoid addStream (const Stream &_stream)
 
knowCore::ReturnValue< QList< Stream > > streams () const
 
knowCore::ReturnValue< bool > hasProperty (const knowCore::Uri &_property) const
 
knowCore::ReturnValue< knowCore::Valueproperty (const knowCore::Uri &_property) const
 
knowCore::ReturnVoid setProperty (const knowCore::Uri &_property, const knowCore::Value &_value) const
 
template<typename _T_ , std::enable_if_t< not std::is_base_of_v< knowCore::Value, _T_ >, bool > = true>
knowCore::ReturnVoid setProperty (const knowCore::Uri &_property, const _T_ &_value) const
 
bool operator== (const Agent &_rhs) const
 
bool isValid () const
 

Friends

class Agents
 

Detailed Description

This class allow to handle a manage a agent

Constructor & Destructor Documentation

◆ Agent()

Agent::Agent ( )

Create an invalid agent

Member Function Documentation

◆ hasProperty()

knowCore::ReturnValue< bool > Agent::hasProperty ( const knowCore::Uri & _property) const
Returns
if the given property is set

◆ name()

QString Agent::name ( ) const
Returns
the name of the agent, can be used for display.

◆ property()

knowCore::ReturnValue< knowCore::Value > Agent::property ( const knowCore::Uri & _property) const
Returns
a value for the given property

◆ setProperty() [1/2]

template<typename _T_ , std::enable_if_t< not std::is_base_of_v< knowCore::Value, _T_ >, bool > = true>
knowCore::ReturnVoid kDBRobotics::Agent::setProperty ( const knowCore::Uri & _property,
const _T_ & _value ) const
inline

Set the value for the given property

◆ setProperty() [2/2]

knowCore::ReturnVoid Agent::setProperty ( const knowCore::Uri & _property,
const knowCore::Value & _value ) const

Set the value for the given property

◆ streams()

knowCore::ReturnValue< QList< Stream > > Agent::streams ( ) const
Returns
the list of streams published by this agent

◆ type()

knowCore::Uri Agent::type ( ) const
Returns
the type of the agent.

◆ uri()

knowCore::Uri Agent::uri ( ) const
Returns
the uri of the agent.

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