BrisaUpnp::BrisaControlPointDevice Class Reference

Class that implements the devices that control point part is going to handle. More...

#include <BrisaUpnp/BrisaControlPointDevice>

List of all members.

Public Types

enum  xmlTags {
  Udn, udn, Major, major,
  Minor, minor, UrlBase, urlBase,
  DeviceType, deviceType, FriendlyName, friendlyName,
  Manufacturer, manufacturer, ManufacturerUrl, manufacturerUrl,
  ModelDescription, modelDescription, ModelName, modelName,
  ModelNumber, modelNumber, ModelUrl, modelUrl,
  SerialNumber, serialNumber, Upc, upc,
  PresentationUrl, presentationUrl, FileAddress, fileAddress
}

Public Member Functions

 BrisaControlPointDevice (QObject *parent=0)
 BrisaControlPointDevice (QTemporaryFile *xml, QUrl *url, QObject *parent=0)
 BrisaControlPointDevice (BrisaControlPointDevice &dev, QObject *parent=0)
 BrisaControlPointDevice (QString udn, QString deviceType="", QString friendlyName="", QString manufacturer="", QString manufacturerURL="", QString modelDescription="", QString modelName="", QString modelNumber="", QString modelURL="", QString serialNumber="", QString UPC="", QString presentationURL="", QObject *parent=0)
 ~BrisaControlPointDevice ()
QString getAttribute (xmlTags key)
void setAttribute (xmlTags key, QString value)
void addIcon (BrisaIcon *icon)
void addService (BrisaControlPointService *service)
void addDevice (BrisaControlPointDevice *device)
QList< BrisaIcon * > getIconList ()
QList
< BrisaControlPointService * > & 
getServiceList ()
QList< BrisaControlPointDevice * > getEmbeddedDeviceList ()
BrisaControlPointServicegetServiceById (QString serviceId)
BrisaControlPointServicegetServiceByType (QString serviceType)
void clear ()

Detailed Description

Class that implements the devices that control point part is going to handle.

Definition at line 54 of file brisacontrolpointdevice.h.


Member Enumeration Documentation

Enumerator:
Udn 
udn 
Major 
major 
Minor 
minor 
UrlBase 
urlBase 
DeviceType 
deviceType 
FriendlyName 
friendlyName 
Manufacturer 
manufacturer 
ManufacturerUrl 
manufacturerUrl 
ModelDescription 
modelDescription 
ModelName 
modelName 
ModelNumber 
modelNumber 
ModelUrl 
modelUrl 
SerialNumber 
serialNumber 
Upc 
upc 
PresentationUrl 
presentationUrl 
FileAddress 
fileAddress 

Definition at line 138 of file brisacontrolpointdevice.h.


Constructor & Destructor Documentation

BrisaControlPointDevice::BrisaControlPointDevice ( QObject *  parent = 0  ) 

Constructor to BrisaControlPointDevice, when it makes use of this constructor the device's attributes should be set.

Parameters:
parent empty

Definition at line 37 of file brisacontrolpointdevice.cpp.

BrisaControlPointDevice::BrisaControlPointDevice ( QTemporaryFile *  xml,
QUrl *  url,
QObject *  parent = 0 
)

Constructor for BrisaControlPointDevice that receives a xml file containing the device description, so that the device's attributes can be initialized.

Parameters:
xml empty
url empty
parent empty

Definition at line 41 of file brisacontrolpointdevice.cpp.

BrisaControlPointDevice::BrisaControlPointDevice ( BrisaControlPointDevice dev,
QObject *  parent = 0 
)

Constructor for BrisaControlPointDevice that receives another object of the same type and copy it's attributes.

Definition at line 82 of file brisacontrolpointdevice.cpp.

BrisaControlPointDevice::BrisaControlPointDevice ( QString  udn,
QString  deviceType = "",
QString  friendlyName = "",
QString  manufacturer = "",
QString  manufacturerURL = "",
QString  modelDescription = "",
QString  modelName = "",
QString  modelNumber = "",
QString  modelURL = "",
QString  serialNumber = "",
QString  UPC = "",
QString  presentationURL = "",
QObject *  parent = 0 
)

Constructor where all device's attributes are passed as parameter.

Parameters:
udn empty
deviceType empty
friendlyName empty
manufacturer empty
manufacturerURL empty
modelDescription empty
modelName empty
modelNumber empty
modelURL empty
serialNumber empty
upc empty
presentationURL empty
parent empty

Definition at line 51 of file brisacontrolpointdevice.cpp.

BrisaControlPointDevice::~BrisaControlPointDevice (  ) 

Destructor

Definition at line 107 of file brisacontrolpointdevice.cpp.


Member Function Documentation

void BrisaControlPointDevice::addDevice ( BrisaControlPointDevice device  ) 

Add a device to device's embedded device list.

Parameters:
device device to add

Definition at line 289 of file brisacontrolpointdevice.cpp.

void BrisaControlPointDevice::addIcon ( BrisaIcon icon  ) 

Add an icon to device's icon list.

Parameters:
icon icon to add

Definition at line 281 of file brisacontrolpointdevice.cpp.

void BrisaControlPointDevice::addService ( BrisaControlPointService service  ) 

Add service to device's service list.

Parameters:
service service to add

Definition at line 285 of file brisacontrolpointdevice.cpp.

void BrisaControlPointDevice::clear (  ) 

Clear device's attributes.

Definition at line 293 of file brisacontrolpointdevice.cpp.

QString BrisaControlPointDevice::getAttribute ( xmlTags  key  ) 

Gets an attribute by key

Parameters:
key attribute key
Returns:
attribute value

Definition at line 179 of file brisacontrolpointdevice.cpp.

QList< BrisaControlPointDevice * > BrisaControlPointDevice::getEmbeddedDeviceList (  ) 

Gets device's embedded device list

Returns:
embedded list

Definition at line 277 of file brisacontrolpointdevice.cpp.

QList< BrisaIcon * > BrisaControlPointDevice::getIconList (  ) 

Gets device's icon list

Returns:
icon list

Definition at line 269 of file brisacontrolpointdevice.cpp.

BrisaControlPointService * BrisaControlPointDevice::getServiceById ( QString  serviceId  ) 

Gets a service by id.

Parameters:
serviceId service id
Returns:
service with corresponding id

Definition at line 251 of file brisacontrolpointdevice.cpp.

BrisaControlPointService * BrisaControlPointDevice::getServiceByType ( QString  serviceType  ) 

Check the device's service list and return the service that has the passed

Parameters:
serviceType type of the service
Returns:
service with corresponding type

Definition at line 260 of file brisacontrolpointdevice.cpp.

QList< BrisaControlPointService * > & BrisaControlPointDevice::getServiceList (  ) 

Gets device's service list

Returns:
service list

Definition at line 273 of file brisacontrolpointdevice.cpp.

void BrisaControlPointDevice::setAttribute ( xmlTags  key,
QString  value 
)

Set a device's attribute

Parameters:
key attribute key
value new attribute value

Definition at line 110 of file brisacontrolpointdevice.cpp.


The documentation for this class was generated from the following files:
Generated on Thu Sep 30 14:04:30 2010 for Brisa by  doxygen 1.6.3