armarx::armem::client Namespace Reference

This file is part of ArmarX. More...

Namespaces
	plugins
	This file is part of ArmarX.
	query
	query_fns
	robot_state
	util

Classes
class	MemoryNameSystem
	The memory name system (MNS) client. 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< 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. More...
void	fromIce (const armem::query::data::Input &ice, QueryInput &input)
void	fromIce (const armem::query::data::Result &ice, QueryResult &result)
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)
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

Typedef Documentation

ComponentPluginUser

using ComponentPluginUser = plugins::ListeningPluginUser

Definition at line 12 of file plugins.h.

ListeningPluginUser

using ListeningPluginUser = plugins::ListeningPluginUser

Definition at line 48 of file ListeningPluginUser.h.

PluginUser

using PluginUser = plugins::PluginUser

Definition at line 53 of file PluginUser.h.

QueryBuilder

typedef query::Builder QueryBuilder

Definition at line 19 of file forward_declarations.h.

Function Documentation

findDataForLink()

std::optional<std::pair<MemoryID, aron::data::VariantPtr> > armarx::armem::client::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 174 of file Reader.cpp.

Here is the call graph for this function:

fromIce() [1/2]

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

Definition at line 53 of file Query.cpp.

Here is the caller graph for this function:

fromIce() [2/2]

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

Definition at line 65 of file Query.cpp.

Here is the call graph for this function:

operator<<()

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

Definition at line 35 of file Query.cpp.

readerFactory()

std::optional<Reader> armarx::armem::client::readerFactory

(

const mns::dto::MemoryServerInterfaces &

server

)

Definition at line 226 of file MemoryNameSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

toIce() [1/2]

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

Definition at line 47 of file Query.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

toIce() [2/2]

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

Definition at line 59 of file Query.cpp.

Here is the call graph for this function:

writerFactory()

std::optional<Writer> armarx::armem::client::writerFactory

(

const mns::dto::MemoryServerInterfaces &

server

)

Definition at line 243 of file MemoryNameSystem.cpp.

Here is the call graph for this function:

Here is the caller graph for this function: