ProfileWriter Class Reference

#include <VisionX/libraries/armem_human/client/HumanProfileWriter.h>

Inheritance diagram for ProfileWriter:

Public Member Functions
bool	commitHumanProfile (const Person &humanProfile, const std::string &provider, const armem::Time &referencedTime, const std::string &entityName="")
bool	commitHumanProfiles (const std::vector< Person > &humanProfiles, const std::string &provider, const armem::Time &referencedTime, const std::string &entityName)
bool	commitPreferencesToProfile (const armarx::armem::human::PersonID &personID, const std::string &providerName, const armem::Time &referencedTime, const armarx::armem::human::Preferences preferences)
void	connect (armem::client::MemoryNameSystem &memoryNameSystem)
Properties	defaultProperties () const override
	ProfileWriter ()
std::string	propertyPrefix () const override
void	registerPropertyDefinitions (armarx::PropertyDefinitionsPtr &def)
bool	setCustomAttributeInProfile (const armarx::armem::human::PersonID &personID, const std::string &providerName, const armem::Time &referencedTime, const std::string key, const std::string value)
bool	setPreferredDrink (const armarx::armem::human::PersonID &personID, const std::string &providerName, const armem::Time &referencedTime, const std::string &drink)
	Inserts the given drink at the first place of the given humans list of preferred drinks, indicating it is the most favorite drink.
	SimpleWriterBase ()
	~ProfileWriter () override
Public Member Functions inherited from SimpleWriterBase
void	connect (armarx::armem::client::MemoryNameSystem &mns)
void	registerPropertyDefinitions (armarx::PropertyDefinitionsPtr &def)
	SimpleWriterBase ()
virtual	~SimpleWriterBase ()=default

Additional Inherited Members
Protected Member Functions inherited from SimpleWriterBase
armem::client::Writer &	memoryWriter ()
const Properties &	properties () const
void	setProperties (const Properties &p)

Constructor & Destructor Documentation

ProfileWriter()

ProfileWriter

(

)

~ProfileWriter()

~ProfileWriter ( )

overridedefault

Member Function Documentation

commitHumanProfile()

bool commitHumanProfile	(	const Person &	humanProfile,
		const std::string &	provider,
		const armem::Time &	referencedTime,
		const std::string &	entityName = "" )

commitHumanProfiles()

bool commitHumanProfiles	(	const std::vector< Person > &	humanProfiles,
		const std::string &	provider,
		const armem::Time &	referencedTime,
		const std::string &	entityName )

commitPreferencesToProfile()

bool commitPreferencesToProfile	(	const armarx::armem::human::PersonID &	personID,
		const std::string &	providerName,
		const armem::Time &	referencedTime,
		const armarx::armem::human::Preferences	preferences )

connect()

void connect

(

armem::client::MemoryNameSystem &

memoryNameSystem

)

defaultProperties()

Properties defaultProperties ( ) const

inlineoverridevirtual

Implements SimpleWriterBase.

propertyPrefix()

std::string propertyPrefix ( ) const

inlineoverridevirtual

Implements SimpleWriterBase.

registerPropertyDefinitions()

void registerPropertyDefinitions

(

armarx::PropertyDefinitionsPtr &

def

)

setCustomAttributeInProfile()

bool setCustomAttributeInProfile	(	const armarx::armem::human::PersonID &	personID,
		const std::string &	providerName,
		const armem::Time &	referencedTime,
		const std::string	key,
		const std::string	value )

setPreferredDrink()

bool setPreferredDrink	(	const armarx::armem::human::PersonID &	personID,
		const std::string &	providerName,
		const armem::Time &	referencedTime,
		const std::string &	drink )

Inserts the given drink at the first place of the given humans list of preferred drinks, indicating it is the most favorite drink.

If the list already contained the drink before, it is moved to the first entry of the list to prevent duplicate entries.

Parameters

personID	identifier of the human (first and last name)
providerName	name of the profile provider
referencedTime	the time at which the preference change occured (used for memory timestamp)
drink	human-readable string describing the drink that is preferred (for example, 'orange juice')

Returns

true iff. the preference was updated successfully

SimpleWriterBase()

SimpleWriterBase

(

)

---

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

• VisionX/libraries/armem_human/client/HumanProfileWriter.h
• VisionX/libraries/armem_human/client/HumanProfileWriter.cpp