fipa::services::ServiceDirectoryEntry Class Reference

The entry definition for a service directory, containing name, type, locator and description. More...

#include <ServiceDirectoryEntry.hpp>

Public Types
enum	Field {   NAME = 0, TYPE, LOCATOR, DESCRIPTION,   TIMESTAMP, END_MARKER }

Public Member Functions
	ServiceDirectoryEntry ()
	ServiceDirectoryEntry (const Name &name, const Type &type, const ServiceLocator &locator, const Description &description)
Name	getName () const
void	setName (const Name &name)
Type	getType () const
void	setType (const Type &type)
ServiceLocator	getLocator () const
void	setLocator (const ServiceLocator &locator)
Description	getDescription () const
void	setDescription (const Description &description)
base::Time	getTimestamp () const
void	updateTimestamp ()
std::string	getFieldContent (ServiceDirectoryEntry::Field field) const
void	setFieldContent (ServiceDirectoryEntry::Field field, const std::string &content)
bool	operator< (const ServiceDirectoryEntry &other) const
std::string	toString () const

Static Public Attributes
static std::map< Field, std::string >	FieldTxt

Detailed Description

The entry definition for a service directory, containing name, type, locator and description.

Member Enumeration Documentation

Field

enum fipa::services::ServiceDirectoryEntry::Field

Enumerator
NAME
TYPE
LOCATOR
DESCRIPTION
TIMESTAMP
END_MARKER

Constructor & Destructor Documentation

ServiceDirectoryEntry() [1/2]

fipa::services::ServiceDirectoryEntry::ServiceDirectoryEntry

(

)

ServiceDirectoryEntry() [2/2]

fipa::services::ServiceDirectoryEntry::ServiceDirectoryEntry	(	const Name &	name,
		const Type &	type,
		const ServiceLocator &	locator,
		const Description &	description
	)

Member Function Documentation

getDescription()

Description fipa::services::ServiceDirectoryEntry::getDescription ( ) const

inline

getFieldContent()

std::string fipa::services::ServiceDirectoryEntry::getFieldContent

(

ServiceDirectoryEntry::Field

field

)

const

Get the string content of field based on the field identifier

Returns

String content of the selected field

getLocator()

ServiceLocator fipa::services::ServiceDirectoryEntry::getLocator ( ) const

inline

Get locator

getName()

Name fipa::services::ServiceDirectoryEntry::getName ( ) const

inline

getTimestamp()

base::Time fipa::services::ServiceDirectoryEntry::getTimestamp ( ) const

inline

getType()

Type fipa::services::ServiceDirectoryEntry::getType ( ) const

inline

The signature type

operator<()

bool fipa::services::ServiceDirectoryEntry::operator< ( const ServiceDirectoryEntry &  other ) const

inline

Comparison operator to allow usage as map key

setDescription()

void fipa::services::ServiceDirectoryEntry::setDescription ( const Description &  description )

inline

setFieldContent()

void fipa::services::ServiceDirectoryEntry::setFieldContent	(	ServiceDirectoryEntry::Field	field,
		const std::string &	content
	)

Set the field content of field based on the field identifier

Exceptions

std::runtime_error

if parsing string content fails

setLocator()

void fipa::services::ServiceDirectoryEntry::setLocator ( const ServiceLocator &  locator )

inline

setName()

void fipa::services::ServiceDirectoryEntry::setName ( const Name &  name )

inline

setType()

void fipa::services::ServiceDirectoryEntry::setType ( const Type &  type )

inline

toString()

std::string fipa::services::ServiceDirectoryEntry::toString

(

)

const

Convert to string representations

Returns

String representation

updateTimestamp()

void fipa::services::ServiceDirectoryEntry::updateTimestamp ( )

inline

Update the modification times of this entry

Member Data Documentation

FieldTxt

std::map< ServiceDirectoryEntry::Field, std::string > fipa::services::ServiceDirectoryEntry::FieldTxt

static

Initial value:

= boost::assign::map_list_of
    (ServiceDirectoryEntry::NAME, "NAME")
    (ServiceDirectoryEntry::TYPE, "TYPE")
    (ServiceDirectoryEntry::LOCATOR, "LOCATOR")
    (ServiceDirectoryEntry::DESCRIPTION, "DESCRIPTION")
    (ServiceDirectoryEntry::TIMESTAMP, "TIMESTAMP")

---

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

• /build/rock-master-18.09-multiagent-fipa-services-0.20171213/src/ServiceDirectoryEntry.hpp
• /build/rock-master-18.09-multiagent-fipa-services-0.20171213/src/ServiceDirectoryEntry.cpp