File Information
Library: UPnP/ServiceDesc
Package: ServiceDesc
Header: Poco/UPnP/ServiceDesc/Action.h
Description
This class represents an action in a UPnP service description.
Inheritance
Direct Base Classes: Poco::RefCountedObject
All Base Classes: Poco::RefCountedObject
Member Summary
Member Functions: arguments, hasReturnArgument, methodName, name, optional, returnArgument, setName, setOptional, setReturnArgument
Inherited Functions: duplicate, referenceCount, release
Types
Arguments
typedef std::vector < Argument > Arguments;
Ptr
typedef Poco::AutoPtr < Action > Ptr;
Constructors
Action
Action();
Creates the Action.
Destructor
~Action 
~Action();
Destroys the Action.
Member Functions
arguments 
const Arguments & arguments() const;
Returns the in and out arguments, not including the return parameter.
arguments
Arguments & arguments();
Returns the in and out arguments, not including the return parameter.
hasReturnArgument
bool hasReturnArgument() const;
Returns true if a return argument exists
methodName
std::string methodName() const;
Returns a transformation of the action name to a valid C++ identifier.
name
const std::string & name() const;
Returns the action's name, UTF-8 encoded.
optional
bool optional() const;
Returns true whether the action is optional, or false otherwise.
returnArgument
const Argument & returnArgument() const;
Returns the return argument.
Will throw a Poco::NotFoundException if no return argument has been set.
setName 
void setName(
const std::string & name
);
Sets the action's name.
setOptional
void setOptional(
bool optional
);
Specifies whether the action is optional.
setReturnArgument
void setReturnArgument(
const Argument & arg
);
Sets a argument as return argument.