Poco::RemotingNG

class AttributedObject

Library: RemotingNG
Package: ORB
Header: Poco/RemotingNG/AttributedObject.h

Description

A AttributedObject can hold any number of attributes in the form of name-value pairs.

Inheritance

Known Derived Classes: Poco::RemotingNG::JSONRPC::Transport, Poco::RemotingNG::REST::Transport, Poco::RemotingNG::HTTP::Transport, Credentials, Transport, Poco::RemotingNG::SOAP::Transport, Poco::RemotingNG::TCP::Transport, EventSubscriber, ServerTransport, Poco::RemotingNG::TCP::ServerTransport, Poco::RemotingNG::TCP::Connection, Skeleton

Member Summary

Member Functions: clearAttributes, countAttributes, enumerateAttributes, getAttribute, hasAttribute, operator =, removeAttribute, setAttribute

Types

NameValueMap

typedef std::map < std::string, std::string > NameValueMap;

Constructors

AttributedObject

AttributedObject();

Creates an AttributedObject.

AttributedObject

AttributedObject(
    const AttributedObject & other
);

Creates an AttributedObject by copying the attributes from another one.

Destructor

~AttributedObject virtual

virtual ~AttributedObject();

Destroys the AttributedObject.

Member Functions

clearAttributes

void clearAttributes();

Removes all attributes.

countAttributes inline

std::size_t countAttributes() const;

Returns the number of attributes.

enumerateAttributes

std::vector < std::string > enumerateAttributes() const;

Returns a vector containing all attribute names.

getAttribute

const std::string & getAttribute(
    const std::string & name
) const;

Returns the value of the attribute with the given name. Throws a Poco::NotFoundException if no such attribute exists.

getAttribute

const std::string & getAttribute(
    const std::string & name,
    const std::string & deflt
) const;

Returns the value of the attribute with the given name, or the given default value if no such attribute exists.

hasAttribute

bool hasAttribute(
    const std::string & name
) const;

Returns true if and only if an attribute with the given name exists.

operator =

AttributedObject & operator = (
    const AttributedObject & other
);

Assigns the attributes from another AttributedObject.

removeAttribute

void removeAttribute(
    const std::string & name
);

Removes the attribute with the given name. Does nothing if no attribute with the given name exists.

setAttribute

void setAttribute(
    const std::string & name,
    const std::string & value
);

Adds or modifies the attribute with the given name.