fipa::acl Namespace Reference

Agent Communication Language. More...

Namespaces
	bitefficient
	conversation
	default_state
	default_transition
	envelope
	grammar
	message
	MessageField
	representation
	validation

Classes
struct	NullDeleter
class	ConversationObserver
class	ConversationObservable
class	Conversation
class	ConversationMonitor
	This library provides a statemachine to monitor a message flow based on performatives. The conversation monitor is capable of monitoring the conversation based on the protocol specified in the messages. There are scxml documents specifying how these protocols are defined. Protocols may contain subprotocols, which is partially supported. More...
class	MessageArchive
class	Role
class	UndefinedRole
class	SelfRole
class	RoleMapping
	Mapping between roles and actual agent ids. More...
class	State
	implements a state of the StateMachine class More...
class	FinalState
class	UndefinedState
class	StateMachine
struct	EmbeddedStateMachine
	An embedded state machine with mappings. More...
class	StateMachineFactory
class	StateMachineReader
	implements a XML parser that generates a state machine from a given spec. file; uses the tinyXML library More...
class	Transition
class	ACLBaseEnvelope
	The ACLBaseEnvelope defines the layout for an envelope with which ACLMessage data can be wrapped. Multiple ACLBaseEnvelopes are part of the ACLEnvelope in order to implement the basic functionality of the Agent Communication Channel (ACC) More...
class	ACLEnvelope
	ACLMessage envelope (also typed as fipa::acl::Letter) includes the base envelope and updated fields, along with the actual payload data that is wrapped by this envelope. More...
class	ACLMessage
	This class provides a representation of a message conforming to the FIPA specification SC00061. More...
class	AgentID
	Implements the general AgentID functionality, which is present throughout the fipa specifications(FIPA at http://www.fipa.org). Functionality may need to be extended as further modules are implemented Important notice: the probably main field of an AgentID, the actual id, is not yet declared/implemented, as it was not need for the encoding and it was not discussed what should it be. More...
class	UndefinedAgentID
class	EnvelopeFormat
class	EnvelopeGenerator
class	BitefficientEnvelopeFormat
class	BitefficientFormat
class	BitefficientMessageFormat
class	StringFormat
class	StringMessageFormat
class	XMLEnvelopeFormat
class	XMLFormat
class	XMLMessageFormat
class	MessageFormat
	Abstract class which should be implemented by a specific format to encode an ACLMessage according to the fipa specification (SC00069) More...
class	MessageGenerator
class	ReceivedObject
class	UserdefParam
	overloaded equality operator for UserdefParam class objects More...
struct	UserDefinedParameter
struct	AgentIdentifier
	Definition for AgentIdentifier. More...
class	AgentIdentifierPrinter
	This class can be used to print the AgentIdentifier. More...
class	BitefficientEnvelopeParser
class	BitefficientMessageParser
	Allows to parse a bytestream that conforms to the bitefficient representation of FIPA messages to a ACLMessage. More...
class	ByteStringPrinter
	Printer using the visitor pattern for the ByteString type. More...
class	ByteStringRawPrinter
	Printer using the visitor pattern for the ByteString type. More...
class	ByteSequence
	Representation of a byte sequence. We also embed information about the encoding. More...
struct	Time
struct	DateTime
class	EnvelopeParserImplementation
class	EnvelopeParser
class	MessageParserImplementation
class	MessageParser
	Allows to parse a bytestream that conforms to the bitefficient representation of FIPA messages to a ACLMessage. More...
class	MessagePrinter
	Allows printing of a newly constructed fipa::acl::Message. More...
class	StringMessageParser
struct	Header
struct	Message
class	XMLEnvelopeParser
class	XMLMessageParser
class	XMLParser

Typedefs
typedef boost::shared_ptr < ConversationObserver >	ConversationObserverPtr
typedef boost::shared_ptr < ConversationObservable >	ConversationObservablePtr
typedef std::vector < ConversationObserverPtr >	ConversationObserverList
typedef boost::shared_ptr < Conversation >	ConversationPtr
typedef std::string	RoleId
typedef std::string	StateId
typedef std::string	Comments
typedef uint32_t	PayloadLength
typedef std::string	PayloadEncoding
typedef std::string	ACLRepresentation
typedef std::string	TransportBehaviour
typedef std::vector < ReceivedObject >	ReceivedObjectList
typedef std::vector < ACLBaseEnvelope >	ACLBaseEnvelopeList
typedef ACLEnvelope	Letter
	Define a letter to be the envelope including the payload. More...
typedef std::string	ConversationID
typedef std::string	Protocol
typedef std::string	ContentLanguage
typedef std::vector< AgentID >	AgentIDList
typedef AgentIDList	Resolvers
typedef std::vector< std::string >	Addresses
typedef boost::shared_ptr < EnvelopeFormat >	EnvelopeFormatPtr
typedef boost::shared_ptr < MessageFormat >	MessageFormatPtr
typedef std::string	URL
typedef std::string	ID
typedef std::string	Via
typedef std::string	Ontology
typedef std::string	Language
typedef std::string	Content
typedef std::string	Performative
typedef std::string	Encoding
typedef std::string	ReplyBy
typedef std::string	InReplyTo
typedef std::string	ReplyWith
typedef std::vector< UserdefParam >	UserdefinedParameterList
typedef boost::recursive_wrapper < AgentIdentifier >	Resolver
typedef boost::variant < std::string, fipa::acl::Resolver, std::vector < fipa::acl::Resolver > , fipa::acl::ByteSequence, fipa::acl::ByteString >	UserDefinedParameterValue
typedef boost::variant < boost::uint_least8_t, boost::uint_least16_t, boost::uint_least32_t >	LengthValue
	Definition of a length - internally used by the parser. More...
typedef boost::variant < std::string, std::vector < unsigned char > >	ByteString
	Definition of a ByteString. More...
typedef boost::shared_ptr < EnvelopeParserImplementation >	EnvelopeParserImplementationPtr
typedef boost::shared_ptr < MessageParserImplementation >	MessageParserImplementationPtr

Functions
template<typename C , typename E >
std::basic_ostream< C, E > &	operator<< (std::basic_ostream< C, E > &out, const AgentID &agent)
template<typename C , typename E >
std::basic_ostream< C, E > &	operator<< (std::basic_ostream< C, E > &out, const AgentIDList &agents)

Variables
std::map < ACLMessage::Performative, std::string >	PerformativeTxt
const std::string	illegalWordChars = std::string("() ") + char(0x00)
const std::string	illegalWordStart = std::string("@#-0123456789")

Detailed Description

Agent Communication Language.

Typedef Documentation

typedef std::vector<ACLBaseEnvelope> fipa::acl::ACLBaseEnvelopeList

Definition at line 19 of file acl_envelope.h.

typedef std::string fipa::acl::ACLRepresentation

Definition at line 15 of file acl_envelope.h.

typedef std::vector<std::string> fipa::acl::Addresses

Definition at line 28 of file agent_id.h.

typedef std::vector<AgentID> fipa::acl::AgentIDList

Definition at line 20 of file agent_id.h.

typedef boost::variant<std::string, std::vector<unsigned char> > fipa::acl::ByteString

Definition of a ByteString.

Definition at line 20 of file byte_sequence.h.

typedef std::string fipa::acl::Comments

Definition at line 12 of file acl_envelope.h.

typedef std::string fipa::acl::Content

Definition at line 14 of file types.h.

typedef std::string fipa::acl::ContentLanguage

Definition at line 30 of file acl_message.h.

typedef std::string fipa::acl::ConversationID

Definition at line 28 of file acl_message.h.

typedef boost::shared_ptr<ConversationObservable> fipa::acl::ConversationObservablePtr

Definition at line 21 of file conversation.h.

typedef std::vector<ConversationObserverPtr> fipa::acl::ConversationObserverList

Definition at line 22 of file conversation.h.

typedef boost::shared_ptr<ConversationObserver> fipa::acl::ConversationObserverPtr

Definition at line 18 of file conversation.h.

typedef boost::shared_ptr<Conversation> fipa::acl::ConversationPtr

Definition at line 408 of file conversation.h.

typedef std::string fipa::acl::Encoding

Definition at line 18 of file types.h.

typedef boost::shared_ptr<EnvelopeFormat> fipa::acl::EnvelopeFormatPtr

Definition at line 19 of file envelope_format.h.

typedef boost::shared_ptr<EnvelopeParserImplementation> fipa::acl::EnvelopeParserImplementationPtr

Definition at line 21 of file envelope_parser.h.

typedef std::string fipa::acl::ID

Definition at line 13 of file received_object.h.

typedef std::string fipa::acl::InReplyTo

Definition at line 20 of file types.h.

typedef std::string fipa::acl::Language

Definition at line 13 of file types.h.

typedef boost::variant<boost::uint_least8_t,boost::uint_least16_t, boost::uint_least32_t> fipa::acl::LengthValue

Definition of a length - internally used by the parser.

Definition at line 15 of file byte_sequence.h.

typedef ACLEnvelope fipa::acl::Letter

Define a letter to be the envelope including the payload.

Definition at line 511 of file acl_envelope.h.

typedef boost::shared_ptr<MessageFormat> fipa::acl::MessageFormatPtr

Definition at line 13 of file message_generator.h.

typedef boost::shared_ptr<MessageParserImplementation> fipa::acl::MessageParserImplementationPtr

Definition at line 19 of file message_parser.h.

typedef std::string fipa::acl::Ontology

Typedefinition for generic fiedls of a fipa message

Definition at line 12 of file types.h.

typedef std::string fipa::acl::PayloadEncoding

Definition at line 14 of file acl_envelope.h.

typedef uint32_t fipa::acl::PayloadLength

Definition at line 13 of file acl_envelope.h.

typedef std::string fipa::acl::Performative

Definition at line 16 of file types.h.

typedef std::string fipa::acl::Protocol

Definition at line 29 of file acl_message.h.

typedef std::vector<ReceivedObject> fipa::acl::ReceivedObjectList

Definition at line 17 of file acl_envelope.h.

typedef std::string fipa::acl::ReplyBy

Definition at line 19 of file types.h.

typedef std::string fipa::acl::ReplyWith

Definition at line 21 of file types.h.

typedef boost::recursive_wrapper<AgentIdentifier> fipa::acl::Resolver

Definition at line 15 of file agent_id.h.

typedef AgentIDList fipa::acl::Resolvers

Definition at line 27 of file agent_id.h.

typedef std::string fipa::acl::RoleId

Definition at line 11 of file role.h.

typedef std::string fipa::acl::StateId

Definition of a StateId

Definition at line 35 of file state.h.

typedef std::string fipa::acl::TransportBehaviour

Definition at line 16 of file acl_envelope.h.

typedef std::string fipa::acl::URL

Definition at line 12 of file received_object.h.

typedef std::vector<UserdefParam> fipa::acl::UserdefinedParameterList

Definition at line 94 of file userdef_param.h.

typedef boost::variant<std::string, fipa::acl::Resolver, std::vector<fipa::acl::Resolver>, fipa::acl::ByteSequence, fipa::acl::ByteString > fipa::acl::UserDefinedParameterValue

Definition at line 19 of file agent_id.h.

typedef std::string fipa::acl::Via

Definition at line 14 of file received_object.h.

Function Documentation

template<typename C , typename E >

std::basic_ostream<C, E>& fipa::acl::operator<<	(	std::basic_ostream< C, E > &	out,
		const AgentID &	agent
	)

Definition at line 201 of file agent_id.h.

{
    out << "AgentID<" << agent.getName() << ">";
    return out;
}

template<typename C , typename E >

std::basic_ostream<C, E>& fipa::acl::operator<<	(	std::basic_ostream< C, E > &	out,
		const AgentIDList &	agents
	)

Definition at line 208 of file agent_id.h.

{
    AgentIDList::const_iterator cit = agents.begin();
    out << "[";
    for(; cit != agents.end(); ++cit)
    {
        out << *cit;
    }
    out << "]";
    return out;
}

Variable Documentation

const std::string fipa::acl::illegalWordChars = std::string("() ") + char(0x00)

Parameters

illegalWordChars

string containing illegal characters according to the fipa definition of a word

Definition at line 39 of file acl_message.cpp.

const std::string fipa::acl::illegalWordStart = std::string("@#-0123456789")

Parameters

illegalWordStart

string containing illegal first characters according to the fipa definition of a word

Definition at line 40 of file acl_message.cpp.

std::map< ACLMessage::Performative, std::string > fipa::acl::PerformativeTxt

Initial value:

= boost::assign::map_list_of
    (ACLMessage::ACCEPT_PROPOSAL, "accept-proposal")
    (ACLMessage::AGREE, "agree")
    (ACLMessage::CANCEL, "cancel")
    (ACLMessage::CALL_FOR_PROPOSAL, "cfp")
    (ACLMessage::CONFIRM, "confirm")
    (ACLMessage::DISCONFIRM, "disconfirm")
    (ACLMessage::FAILURE, "failure")
    (ACLMessage::INFORM, "inform")
    (ACLMessage::INFORM_IF, "inform-if")
    (ACLMessage::INFORM_REF, "inform-ref")
    (ACLMessage::NOT_UNDERSTOOD, "not-understood")
    (ACLMessage::PROPAGATE, "propagate")
    (ACLMessage::PROPOSE, "propose")
    (ACLMessage::PROXY, "proxy")
    (ACLMessage::QUERY_IF, "query-if")
    (ACLMessage::QUERY_REF, "query-ref")
    (ACLMessage::REFUSE, "refuse")
    (ACLMessage::REJECT_PROPOSAL, "reject-proposal")
    (ACLMessage::REQUEST, "request")
    (ACLMessage::REQUEST_WHEN, "request-when")
    (ACLMessage::REQUEST_WHENEVER, "request-whenever")
    (ACLMessage::SUBSCRIBE, "subscribe")

Definition at line 15 of file acl_message.cpp.