org.openbase.bco.registry.unit.lib.generator

Class UntShapeGenerator

java.lang.Object

org.openbase.bco.registry.unit.lib.generator.UntShapeGenerator

public class UntShapeGenerator
extends Object

Constructor Summary

Constructors

Constructor and Description
UntShapeGenerator()

Method Summary

Modifier and Type	Method and Description
static rst.spatial.ShapeType.Shape	generateUnitShape(String unitId, UnitConfigCollectionProvider unitConfigCollectionProvider, DeviceClassCollectionProvider deviceClassCollectionProvider) Method returns the unit shape of the given unit referred by the id.
static rst.spatial.ShapeType.Shape	generateUnitShape(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig, UnitConfigCollectionProvider unitConfigCollectionProvider, DeviceClassCollectionProvider deviceClassCollectionProvider) Method returns the unit shape of the given unit referred by the unit config.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UntShapeGenerator

public UntShapeGenerator()

Method Detail

generateUnitShape

public static rst.spatial.ShapeType.Shape generateUnitShape(rst.domotic.unit.UnitConfigType.UnitConfig unitConfig,
                                                            UnitConfigCollectionProvider unitConfigCollectionProvider,
                                                            DeviceClassCollectionProvider deviceClassCollectionProvider)
                                                     throws org.openbase.jul.exception.NotAvailableException

Method returns the unit shape of the given unit referred by the unit config.

If this unit configuration does not provide any shape information the shape of the unit host will be returned. In case the unit host even does not provide any shape information and the unit is a device than the shape of the device class will be used.

Parameters:

unitConfig - the unit config to generate the shape for.

unitConfigCollectionProvider - provider to resolve the unit config by id.

deviceClassCollectionProvider - provider to resolve the unit class by id.

Returns:

the shape representing the unit.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if the unit shape is not available or the resolution has been failed.

generateUnitShape

public static rst.spatial.ShapeType.Shape generateUnitShape(String unitId,
                                                            UnitConfigCollectionProvider unitConfigCollectionProvider,
                                                            DeviceClassCollectionProvider deviceClassCollectionProvider)
                                                     throws org.openbase.jul.exception.NotAvailableException

Method returns the unit shape of the given unit referred by the id.

If this unit configuration does not provide any shape information the shape of the unit host will be returned. In case the unit host even does not provide any shape information and the unit is a device than the shape of the device class will be used.

Parameters:

unitId - the id to resolve the unit shape.

unitConfigCollectionProvider - provider to resolve the unit config by id.

deviceClassCollectionProvider - provider to resolve the unit class by id.

Returns:

the shape representing the unit.

Throws:

org.openbase.jul.exception.NotAvailableException - is thrown if the unit shape is not available or the resolution has been failed.