This file is part of ArmarX. More...

Namespaces
namespace	plugins
	This file is part of ArmarX.

namespace	query

namespace	query_fns

namespace	robot_state

namespace	util

Classes
class	Configurator
	Configure a memory server. More...

class	Loader
	Load LTMs into WM. More...

class	MemoryNameSystem
	The memory name system (MNS) client. More...

class	ProprioceptionStressTest
	Debug component for stress-testing the Proprioception segment of RobotStateMemory with high-frequency read and write operations. More...

struct	QueryInput
	A query for parts of a memory. More...

struct	QueryResult
	Result of a `QueryInput`. More...

class	Reader
	Reads data from a memory server. More...

class	ReadStream
	A stream reading entity snapshots from the memory. More...

class	Writer
	Helps a memory client sending data to a memory. More...

Typedefs
using	ComponentPluginUser = plugins::ListeningPluginUser

using	ListeningPluginUser = plugins::ListeningPluginUser

using	PluginUser = plugins::PluginUser

using	QueryBuilder = query::Builder

Functions
std::optional< Configurator >	configuratorFactory (const mns::dto::MemoryServerInterfaces &server)

std::optional< std::pair< MemoryID, aron::data::VariantPtr > >	findDataForLink (const aron::data::VariantPtr &linkData, const aron::type::VariantPtr &linkType, armem::client::MemoryNameSystem &mns)
	Get the MemoryID and data required to fill in the given MemoryLink.

void	fromIce (const armem::query::data::Input &ice, QueryInput &input)

void	fromIce (const armem::query::data::Result &ice, QueryResult &result)

template<class IceKeyT, class IceValueT, class CppKeyT, class CppValueT>
void	fromIce (const std::map< IceKeyT, IceValueT > &iceMap, boost::container::flat_map< CppKeyT, CppValueT > &cppMap)

std::optional< Loader >	loaderFactory (const mns::dto::MemoryServerInterfaces &server)

std::ostream &	operator<< (std::ostream &os, const QueryResult &rhs)

std::optional< Reader >	readerFactory (const mns::dto::MemoryServerInterfaces &server)

void	toIce (armem::query::data::Input &ice, const QueryInput &input)

void	toIce (armem::query::data::Result &ice, const QueryResult &result)

template<class IceKeyT, class IceValueT, class CppKeyT, class CppValueT>
void	toIce (std::map< IceKeyT, IceValueT > &iceMap, const boost::container::flat_map< CppKeyT, CppValueT > &cppMap)

std::optional< Writer >	writerFactory (const mns::dto::MemoryServerInterfaces &server)

Detailed Description

This file is part of ArmarX.

ArmarX is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

ArmarX is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Author: Fabian Reister ( fabian dot reister at kit dot edu )

Date: 2022

Copyright: http://www.gnu.org/licenses/gpl-2.0.txt GNU General Public License

ArmarX is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 2 as published by the Free Software Foundation.

ArmarX is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Author: Fabian Reister ( fabian dot reister at kit dot edu )

Date: 2024

Copyright: http://www.gnu.org/licenses/gpl-2.0.txt GNU General Public License

Typedef Documentation

◆ ComponentPluginUser

using ComponentPluginUser = plugins::ListeningPluginUser

Definition at line 10 of file plugins.h.

◆ ListeningPluginUser

using ListeningPluginUser = plugins::ListeningPluginUser

Definition at line 41 of file ListeningPluginUser.h.

◆ PluginUser

using PluginUser = plugins::PluginUser

Definition at line 47 of file PluginUser.h.

◆ QueryBuilder

using QueryBuilder = query::Builder

Definition at line 18 of file forward_declarations.h.

Function Documentation

◆ configuratorFactory()

std::optional< Configurator > configuratorFactory ( const mns::dto::MemoryServerInterfaces & server )

Definition at line 342 of file MemoryNameSystem.cpp.

Here is the caller graph for this function:

◆ findDataForLink()

std::optional< std::pair< MemoryID, aron::data::VariantPtr > > findDataForLink	(	const aron::data::VariantPtr &	linkData,
		const aron::type::VariantPtr &	linkType,
		armem::client::MemoryNameSystem &	mns )

Get the MemoryID and data required to fill in the given MemoryLink.

Returns nothing if the data could not be retrieved or its type does not match the MemoryLink's template type.

Parameters

linkData	the data object of the MemoryLink
linkType	the type object of the MemoryLink

Returns: a pair of memoryID and data to fill in a MemoryLink, or nothing if not available

Definition at line 258 of file Reader.cpp.

Here is the call graph for this function:

◆ fromIce() [1/3]

void fromIce	(	const armem::query::data::Input &	ice,
		QueryInput &	input )

Definition at line 56 of file Query.cpp.

Here is the caller graph for this function:

◆ fromIce() [2/3]

void fromIce	(	const armem::query::data::Result &	ice,
		QueryResult &	result )

Definition at line 71 of file Query.cpp.

Here is the call graph for this function:

◆ fromIce() [3/3]

template<class IceKeyT, class IceValueT, class CppKeyT, class CppValueT>

void fromIce	(	const std::map< IceKeyT, IceValueT > &	iceMap,
		boost::container::flat_map< CppKeyT, CppValueT > &	cppMap )

Definition at line 27 of file ice_conversions_boost_templates.h.

◆ loaderFactory()

std::optional< Loader > loaderFactory ( const mns::dto::MemoryServerInterfaces & server )

Definition at line 353 of file MemoryNameSystem.cpp.

Here is the caller graph for this function:

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	os,
		const QueryResult &	rhs )

Definition at line 37 of file Query.cpp.

◆ readerFactory()

std::optional< Reader > readerFactory ( const mns::dto::MemoryServerInterfaces & server )

Definition at line 364 of file MemoryNameSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toIce() [1/3]

void toIce	(	armem::query::data::Input &	ice,
		const QueryInput &	input )

Definition at line 49 of file Query.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toIce() [2/3]

void toIce	(	armem::query::data::Result &	ice,
		const QueryResult &	result )

Definition at line 64 of file Query.cpp.

Here is the call graph for this function:

◆ toIce() [3/3]

template<class IceKeyT, class IceValueT, class CppKeyT, class CppValueT>

void toIce	(	std::map< IceKeyT, IceValueT > &	iceMap,
		const boost::container::flat_map< CppKeyT, CppValueT > &	cppMap )

Definition at line 15 of file ice_conversions_boost_templates.h.

◆ writerFactory()

std::optional< Writer > writerFactory ( const mns::dto::MemoryServerInterfaces & server )

Definition at line 386 of file MemoryNameSystem.cpp.

Here is the caller graph for this function:

Namespaces

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ ComponentPluginUser

◆ ListeningPluginUser

◆ PluginUser

◆ QueryBuilder

Function Documentation

◆ configuratorFactory()

◆ findDataForLink()

◆ fromIce() [1/3]

◆ fromIce() [2/3]

◆ fromIce() [3/3]

◆ loaderFactory()

◆ operator<<()

◆ readerFactory()

◆ toIce() [1/3]

◆ toIce() [2/3]

◆ toIce() [3/3]

◆ writerFactory()