buzz.getcoco.iot

Class CapabilityEnergyMetering

java.lang.Object

buzz.getcoco.iot.Capability

buzz.getcoco.iot.CapabilityEnergyMetering

All Implemented Interfaces:

java.lang.Iterable<Attribute>

public class CapabilityEnergyMetering
extends Capability

This class describes Commands and Attributes for Energy Metering Capability of a Resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CapabilityEnergyMetering.AttributeId enum denoting various possible attributes of the CapabilityEnergyMetering.
static class	CapabilityEnergyMetering.CommandId enum denoting the possible Commands that can be sent for CapabilityEnergyMetering.
static class	CapabilityEnergyMetering.GetConsumption This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending get consumption command.
static class	CapabilityEnergyMetering.GetDemand This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending get demand command.
static class	CapabilityEnergyMetering.Reset This class can be sent as an argument to Capability.sendResourceCommand(buzz.getcoco.iot.Command<T>, buzz.getcoco.iot.Capability.CommandStatusListener<T>) while sending reset command.

Nested classes/interfaces inherited from class buzz.getcoco.iot.Capability

Capability.CapabilityId, Capability.CommandStatusListener<T extends Capability.CommandId>

Field Summary

Fields

Modifier and Type	Field and Description
static Capability.CapabilityId	ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CapabilityEnergyMetering(int id, Resource parent) Constructor of the current class.

Method Summary

Modifier and Type	Method and Description
protected Command<? extends Capability.CommandId>	extendedCreateCommand(int primitiveCommandId, com.google.gson.JsonElement commandParams) A function to create the command from the Json params.
boolean	supports(Capability.CommandId commandId) This function is used to check if a command is supported by the capability or not.

Methods inherited from class buzz.getcoco.iot.Capability

clearAndSetStandardCommandSet, containsAttribute, containsAttribute, createCommand, createCommandResponseArgs, getAttribute, getAttribute, getAttributeMap, getCapabilityWrapper, getId, getName, getParent, getSupportedCommands, hashCode, interceptCommand, internalAddAttribute, internalMarkAsReady, internalRemoveAttribute, internalSetName, internalSetParent, isReady, iterator, sendResourceCommand, setCapabilityWrapper, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ID

public static final Capability.CapabilityId ID

Constructor Detail

CapabilityEnergyMetering

protected CapabilityEnergyMetering(int id,
                                   Resource parent)

Constructor of the current class.

Parameters:

id - The unique id Of the capability

parent - The parent Resource of the capability.

Method Detail

supports

public boolean supports(Capability.CommandId commandId)

This function is used to check if a command is supported by the capability or not.

Overrides:

supports in class Capability

Parameters:

commandId - The Id denoting the command to be sent.

Returns:

boolean: If the command is supported then True is returned.

extendedCreateCommand

protected Command<? extends Capability.CommandId> extendedCreateCommand(int primitiveCommandId,
                                                                        com.google.gson.JsonElement commandParams)

A function to create the command from the Json params.

Specified by:

extendedCreateCommand in class Capability

Parameters:

primitiveCommandId - The int form of the commandId

commandParams - The Json params that can form a command

Returns:

The command which is formed