UPnP::ObjectClass Struct Reference

Describes device or service class. More...

#include <ObjectClass.h>

Collaboration diagram for UPnP::ObjectClass:

Classes
struct	Device
	Device description fields. More...
struct	Service
	Service description fields. More...

Public Types
using	List = const FSTR::Vector< ObjectClass > &
using	Kind = Urn::Kind
using	Version = uint8_t
	Interface version number. More...
using	CreateObject = Object *(*)(DeviceControl *owner)
	Object constructor function. More...

Public Member Functions
const FlashString &	domain () const
const FlashString &	type () const
const Device *	device () const
const Service *	service () const
Version	version () const
Kind	kind () const
DeviceControl *	createRootDevice () const
DeviceControl *	createDevice (DeviceControl &owner) const
ServiceControl *	createService (DeviceControl &owner) const
Urn	objectType () const
bool	operator== (const ObjectClass &other) const
bool	typeIs (const Urn &objectType) const
bool	typeIs (Urn::Kind kind, const String &type, uint8_t version) const
	operator bool () const

Public Attributes
Kind	kind_
Version	version_
const FlashString *	domain_
const FlashString *	type_
const CreateObject	createObject_
union {
const Device *   device_
const Service *   service_
};

Detailed Description

Describes device or service class.

Member Typedef Documentation

CreateObject

using UPnP::ObjectClass::CreateObject = Object* (*)(DeviceControl* owner)

Object constructor function.

Kind

using UPnP::ObjectClass::Kind = Urn::Kind

List

using UPnP::ObjectClass::List = const FSTR::Vector<ObjectClass>&

Version

using UPnP::ObjectClass::Version = uint8_t

Interface version number.

Member Function Documentation

createDevice()

DeviceControl* UPnP::ObjectClass::createDevice ( DeviceControl &  owner ) const

inline

createRootDevice()

DeviceControl* UPnP::ObjectClass::createRootDevice ( ) const

inline

createService()

ServiceControl* UPnP::ObjectClass::createService ( DeviceControl &  owner ) const

inline

device()

const Device* UPnP::ObjectClass::device ( ) const

inline

domain()

const FlashString& UPnP::ObjectClass::domain ( ) const

inline

kind()

Kind UPnP::ObjectClass::kind ( ) const

inline

objectType()

Urn UPnP::ObjectClass::objectType

(

)

const

operator bool()

UPnP::ObjectClass::operator bool ( ) const

inlineexplicit

operator==()

bool UPnP::ObjectClass::operator==

(

const ObjectClass &

other

)

const

service()

const Service* UPnP::ObjectClass::service ( ) const

inline

type()

const FlashString& UPnP::ObjectClass::type ( ) const

inline

typeIs() [1/2]

bool UPnP::ObjectClass::typeIs

(

const Urn &

objectType

)

const

typeIs() [2/2]

bool UPnP::ObjectClass::typeIs	(	Urn::Kind	kind,
		const String &	type,
		uint8_t	version
	)		const

version()

Version UPnP::ObjectClass::version ( ) const

inline

Member Data Documentation

union { ... }

createObject_

const CreateObject UPnP::ObjectClass::createObject_

device_

const Device* UPnP::ObjectClass::device_

domain_

const FlashString* UPnP::ObjectClass::domain_

kind_

Kind UPnP::ObjectClass::kind_

service_

const Service* UPnP::ObjectClass::service_

type_

const FlashString* UPnP::ObjectClass::type_

version_

Version UPnP::ObjectClass::version_

---

The documentation for this struct was generated from the following file:

• ObjectClass.h