This class is used to contain information of a UPnP action found in a UPnP service description document. More...
#include <HActionInfo>
Public Member Functions | |
HActionInfo () | |
HActionInfo (const QString &name, HInclusionRequirement incReq=InclusionMandatory, QString *err=0) | |
HActionInfo (const QString &name, const HActionArguments &inputArguments, const HActionArguments &outputArguments, bool hasRetVal, HInclusionRequirement incReq=InclusionMandatory, QString *err=0) | |
HActionInfo (const HActionInfo &other) | |
~HActionInfo () | |
HActionInfo & | operator= (const HActionInfo &other) |
QString | name () const |
const HActionArguments & | inputArguments () const |
const HActionArguments & | outputArguments () const |
QString | returnArgumentName () const |
HInclusionRequirement | inclusionRequirement () const |
bool | isValid () const |
Friends | |
H_UPNP_CORE_EXPORT bool | operator== (const HActionInfo &, const HActionInfo &) |
Related Functions | |
(Note that these are not member functions.) | |
H_UPNP_CORE_EXPORT bool | operator!= (const HActionInfo &, const HActionInfo &) |
H_UPNP_CORE_EXPORT quint32 | qHash (const HActionInfo &key) |
UPnP service description documents specify the actions and state variables of the service. An instance of this class contain the information of an action found in a service description document:
In addition to the information found in the service description document, the UPnP service containing the action that is depicted by the HActionInfo object may have specified additional information about the action. Currently only inclusionRequirement() is available and it details whether the action is considered as mandatory or optional.
HActionInfo | ( | ) |
Creates a new, invalid instance.
HActionInfo | ( | const QString & | name, |
HInclusionRequirement | incReq = InclusionMandatory , |
||
QString * | err = 0 |
||
) |
Creates a new instance.
name | specifies the name of the action. |
incReq | specifies whether the action is required by the containing service. |
err | specifies a pointer to a QString , which contains an error description in case the construction failed. This parameter is optional. |
HActionInfo | ( | const QString & | name, |
const HActionArguments & | inputArguments, | ||
const HActionArguments & | outputArguments, | ||
bool | hasRetVal, | ||
HInclusionRequirement | incReq = InclusionMandatory , |
||
QString * | err = 0 |
||
) |
Creates a new instance.
name | specifies the name of the action. |
inputArguments | specifies the input arguments of the action. These are the arguments the user has to provide when the action is invoked. |
outputArguments | specifies the output arguments of the action. These are the arguments the action will "return" when the action invocation is successfully completed. |
hasRetVal | specifies whether the action has a return value. If this is true the first element of the outputArguments is considered as the return value. Note also that if this is true the outputArguments cannot be empty. |
incReq | specifies whether the action is required or optional. |
err | specifies a pointer to a QString , which contains an error description in case the construction failed. This parameter is optional. |
HActionInfo | ( | const HActionInfo & | other ) |
Copies the contents of the other to this.
other | specifies the object to be copied. |
~HActionInfo | ( | ) |
Destroys the instance.
HActionInfo & operator= | ( | const HActionInfo & | other ) |
Assigns the contents of the other to this.
other | specifies the object to be copied. |
QString name | ( | ) | const |
Returns the name of the action.
This is the name specified in the corresponding service description file.
const HActionArguments & inputArguments | ( | ) | const |
Returns the input arguments the action expects.
These are the arguments the user has to provide when invoking the action that this info object portrays.
const HActionArguments & outputArguments | ( | ) | const |
Returns the output arguments of the action.
These are the arguments each successful action invocation will "return" to user as output values.
QString returnArgumentName | ( | ) | const |
Returns the name of the output argument that is marked as the action's return value.
HInclusionRequirement inclusionRequirement | ( | ) | const |
Indicates whether the action is required or optional.
bool isValid | ( | ) | const |
Indicates if the object is empty.
H_UPNP_CORE_EXPORT bool operator== | ( | const HActionInfo & | , |
const HActionInfo & | |||
) | [friend] |
Compares the two objects for equality.
H_UPNP_CORE_EXPORT bool operator!= | ( | const HActionInfo & | , |
const HActionInfo & | |||
) | [related] |
Compares the two objects for inequality.
H_UPNP_CORE_EXPORT quint32 qHash | ( | const HActionInfo & | key ) | [related] |
Returns a value that can be used as a unique key in a hash-map identifying the object.
key | specifies the HActionInfo object from which the hash value is created. |