PLT_ActionDesc Class Reference

The PLT_ActionDesc class provides information about a UPnP Service given action. More...

#include <PltAction.h>

Collaboration diagram for PLT_ActionDesc:

Public Member Functions
	PLT_ActionDesc (const char *name, PLT_Service *service)
	Constructor. More...
NPT_Array< PLT_ArgumentDesc * > &	GetArgumentDescs ()
	Return an array of arguments. More...
const NPT_String &	GetName () const
	Return the action name. More...
PLT_ArgumentDesc *	GetArgumentDesc (const char *name)
	Look for an argument given a name. More...
NPT_Result	GetSCPDXML (NPT_XmlElementNode *node)
	Serialize action information to xml into an existing xml tree. More...
PLT_Service *	GetService ()
	Return the service the action is associated with.

Protected Attributes
NPT_String	m_Name
PLT_Service *	m_Service
NPT_Array< PLT_ArgumentDesc * >	m_ArgumentDescs

Detailed Description

The PLT_ActionDesc class provides information about a UPnP Service given action.

This description has a name, a set of arguments and is associated to a service.

Constructor & Destructor Documentation

PLT_ActionDesc()

PLT_ActionDesc::PLT_ActionDesc	(	const char *	name,
		PLT_Service *	service
	)

Constructor.

Parameters

name	the action name
service	the UPnP service the action is associated with

Member Function Documentation

GetArgumentDesc()

PLT_ArgumentDesc * PLT_ActionDesc::GetArgumentDesc

(

const char *

name

)

Look for an argument given a name.

Parameters

name	argument name

Returns

PLT_ArgumentDesc pointer

GetArgumentDescs()

NPT_Array<PLT_ArgumentDesc*>& PLT_ActionDesc::GetArgumentDescs ( )

inline

Return an array of arguments.

Returns

array of arguments

GetName()

const NPT_String& PLT_ActionDesc::GetName ( ) const

inline

Return the action name.

Returns

action name.

GetSCPDXML()

NPT_Result PLT_ActionDesc::GetSCPDXML

(

NPT_XmlElementNode *

node

)

Serialize action information to xml into an existing xml tree.

Parameters

node	the xml Element to serialize action information

---

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

• lib/libUPnP/Platinum/Source/Core/PltAction.h
• lib/libUPnP/Platinum/Source/Core/PltAction.cpp