fipa::acl::UserdefParam Class Reference

overloaded equality operator for UserdefParam class objects More...

#include <userdef_param.h>

Public Member Functions
	UserdefParam ()
	UserdefParam (const std::string &name, const std::string &value="")
UserdefParam &	operator= (const UserdefParam &other)
bool	operator== (const UserdefParam &other) const
const std::string &	getValue () const
void	setValue (const std::string &value)
const std::string &	getName () const
void	setName (const std::string &name)
	the method checks whether the passed name string is a word or not(according to the fipa spec) More...
std::string	toString () const

Detailed Description

overloaded equality operator for UserdefParam class objects

Implements the general User-defined parameters, which are present throughout the fipa specifications(FIPA at http://www.fipa.org).

Definition at line 25 of file userdef_param.h.

Constructor & Destructor Documentation

fipa::acl::UserdefParam::UserdefParam

(

)

Default constructor

Definition at line 17 of file userdef_param.cpp.

    : mName()
    , mValue()
{
}

fipa::acl::UserdefParam::UserdefParam	(	const std::string &	name,
		const std::string &	value = ""
	)

Constructor for a userdefined parameter of a given name

Parameters

name	Name of the userdefined parameter
value	Value of the userdefined parameter

Definition at line 23 of file userdef_param.cpp.

    : mName(name)
    , mValue(value)
{
}

Member Function Documentation

const std::string& fipa::acl::UserdefParam::getName ( ) const

inline

Get the name of the userdefined parameter

Returns

name

Definition at line 77 of file userdef_param.h.

{ return mName; }

const std::string& fipa::acl::UserdefParam::getValue ( ) const

inline

Get value of the userdefined parameter

Returns

value of the userdefined parameter

Definition at line 65 of file userdef_param.h.

{ return mValue; }

UserdefParam & fipa::acl::UserdefParam::operator=

(

const UserdefParam &

other

)

Assignment operator

Definition at line 29 of file userdef_param.cpp.

{
    if(this != &other)
    {
        mName = other.mName;
        mValue = other.mValue;
    }

    return *this;
}

bool fipa::acl::UserdefParam::operator==

(

const UserdefParam &

other

)

const

Comparision operator

Definition at line 40 of file userdef_param.cpp.

{
    return mName == other.mName && mValue == other.mValue;
}

void fipa::acl::UserdefParam::setName

(

const std::string &

name

)

the method checks whether the passed name string is a word or not(according to the fipa spec)

Parameters

name	Name to set for the userdefined parameter

Exceptions

std::runtime_error

if name is not valid

Definition at line 45 of file userdef_param.cpp.

{
    if ( (name.find_first_of(illegalWordChars) != std::string::npos) || (illegalWordStart.find_first_of(name.c_str()[0]) != std::string::npos) )
    {
        throw std::runtime_error("Illegal name for userdefined-parameter");
    }
    mName = name;
}

void fipa::acl::UserdefParam::setValue ( const std::string &  value )

inline

Set the value associated with the userdefined parameter

Parameters

value

Value of the userdefined parameter

Definition at line 71 of file userdef_param.h.

{ mValue = value; }

std::string fipa::acl::UserdefParam::toString

(

)

const

Stringify object

Returns

string presentation

Definition at line 54 of file userdef_param.cpp.

{
    return mName + ": " + mValue;
}

---

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

• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/message_generator/userdef_param.h
• /build/rock-master-18.09-multiagent-fipa-acl-0.20180914/src/message_generator/userdef_param.cpp