PLT_ActionDesc Class Reference

#include <PltAction.h>

Public Member Functions
	PLT_ActionDesc (const char *name, PLT_Service *service)
	~PLT_ActionDesc ()
PLT_ArgumentDesc *	GetArgumentDesc (const char *name)
NPT_Array< PLT_ArgumentDesc * > &	GetArgumentDescs ()
const NPT_String &	GetName () const
NPT_Result	GetSCPDXML (NPT_XmlElementNode *node)
PLT_Service *	GetService ()

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

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.

Definition at line 61 of file PltAction.h.

Constructor & Destructor Documentation

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

Definition at line 49 of file PltAction.cpp.

PLT_ActionDesc::~PLT_ActionDesc

(

)

Definition at line 58 of file PltAction.cpp.

Member Function Documentation

PLT_ArgumentDesc * PLT_ActionDesc::GetArgumentDesc

(

const char *

name

)

Look for an argument given a name.

Parameters

name	argument name

Returns

PLT_ArgumentDesc pointer

Definition at line 97 of file PltAction.cpp.

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

inline

Return an array of arguments.

Returns

array of arguments

Definition at line 76 of file PltAction.h.

const NPT_String& PLT_ActionDesc::GetName ( ) const

inline

Return the action name.

Returns

action name.

Definition at line 84 of file PltAction.h.

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

Definition at line 67 of file PltAction.cpp.

PLT_Service * PLT_ActionDesc::GetService

(

)

Return the service the action is associated with.

Definition at line 88 of file PltAction.cpp.

Member Data Documentation

NPT_Array<PLT_ArgumentDesc*> PLT_ActionDesc::m_ArgumentDescs

protected

Definition at line 108 of file PltAction.h.

NPT_String PLT_ActionDesc::m_Name

protected

Definition at line 106 of file PltAction.h.

PLT_Service* PLT_ActionDesc::m_Service

protected

Definition at line 107 of file PltAction.h.

---

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

• PltAction.h
• PltAction.cpp