Class Poco::UPnP::ServiceDesc::Argument

File Information

Library: UPnP/ServiceDesc
Package: ServiceDesc
Header: Poco/UPnP/ServiceDesc/Argument.h

Description

This class represents an argument to an Action in a UPnP service description.

Member Summary

Member Functions: direction, name, operator =, parameterName, setDirection, setName, setStateVariable, stateVariable

Enumerations

Direction

DIR_IN = 0

input parameter

DIR_OUT

output parameter

DIR_RETURN

return value

Constructors

Argument

Argument();

Creates the Argument.

Argument

Argument(
const Argument & arg
);

Creates the Argument by copying another one.

Destructor

~Argument

~Argument();

Destroys the Argument.

Member Functions

direction

Direction direction() const;

Returns the kind of parameter (input, output or return value).

name

const std::string & name() const;

Returns the name of the argument.

operator =

Argument & operator = (
const Argument & param679
);

Assignment operator.

parameterName

std::string parameterName() const;

Returns a transformation of the parameter name to a valid C++ identifier.

stateVariable

const std::string & stateVariable() const;

Returns the name of the related state variable in the service's state variable table.

setDirection

void setDirection(
Direction dir
);

Sets the direction of the argument.

setName

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

Sets the name of the argument.

setStateVariable

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

Sets the name of the related state variable.