Skip navigation links
A B C D E F G H I K L M N O P Q R S T U V W Z 

C

Calendar - Interface in org.ogema.model.time
Calendar for a person or any resource in shared use
CalendarEntry - Interface in org.ogema.model.time
Entry into the calendar of a building resource, a person etc.
ChannelAccess - Interface in org.ogema.core.channelmanager
ChannelAccess is the Interface between ChannelManager and Application.
ChannelAccessException - Exception in org.ogema.core.channelmanager
ChannelAccessException is thrown by the ChannelAccess interface.
ChannelAccessException(String) - Constructor for exception org.ogema.core.channelmanager.ChannelAccessException
 
ChannelAccessException(Exception) - Constructor for exception org.ogema.core.channelmanager.ChannelAccessException
 
ChannelAccessException(String, Exception) - Constructor for exception org.ogema.core.channelmanager.ChannelAccessException
 
channelAdded(ChannelLocator) - Method in interface org.ogema.core.channelmanager.driverspi.ChannelDriver
A new channel that should be managed by this driver has been added to the system.
ChannelConfiguration - Interface in org.ogema.core.channelmanager
ChannelCofiguration is the Interface for the Configurations of Channels
ChannelConfiguration.Direction - Enum in org.ogema.core.channelmanager
Direction of the Channel,
INPUT = read the values from channel
OUTPUT = write values at the channel
ChannelDriver - Interface in org.ogema.core.channelmanager.driverspi
The ChannelDriver interface has to be implemented by each low-level protocol driver.
channelEvent(EventType, List<SampledValueContainer>) - Method in interface org.ogema.core.channelmanager.ChannelEventListener
Catch ChannelEvents and report.
ChannelEventListener - Interface in org.ogema.core.channelmanager
ChannelEventListener is the Interface between ChannelManager and HighLevel driver.
channelFound(ChannelLocator) - Method in interface org.ogema.core.channelmanager.driverspi.ChannelScanListener
 
ChannelLocator - Class in org.ogema.core.channelmanager.driverspi
The unique description of a channel.
ChannelLocator(String, DeviceLocator) - Constructor for class org.ogema.core.channelmanager.driverspi.ChannelLocator
 
channelRemoved(ChannelLocator) - Method in interface org.ogema.core.channelmanager.driverspi.ChannelDriver
A channel managed by this driver has been removed from the system.
ChannelScanListener - Interface in org.ogema.core.channelmanager.driverspi
Monitor available Channels
channelsUpdated(List<SampledValueContainer>) - Method in interface org.ogema.core.channelmanager.driverspi.ChannelUpdateListener
ChannelUpdate Event
ChannelUpdateListener - Interface in org.ogema.core.channelmanager.driverspi
Monitor registered channels
chargeSensor() - Method in interface org.ogema.model.devices.storage.EnergyStorage
State of charge sensor and storage information.
chargingMode() - Method in interface org.ogema.model.devices.storage.ChargingPoint
Charging mode according to IEC 62196-1 1: Mode 1 - slow charging from a household-type socket-outlet 2: Mode 2 - slow charging from a household-type socket-outlet with an in-cable protection device 3: Mode 3 - slow or fast charging using a specific EV socket-outlet with control and protection function installed 4: Mode 4 - fast charging using an external charger; DC charging 9999: other 10000+: custom modes
ChargingPoint - Interface in org.ogema.model.devices.storage
 
chargingPoints() - Method in interface org.ogema.model.devices.storage.ElectricityChargingStation
Actual charging points of this charging station.
CircuitConnection - Interface in org.ogema.model.connections
Defines a connection between two physical objects.
cityCode() - Method in interface org.ogema.model.stakeholders.PhoneNumber
Area code / prefix to be used within the country, without starting "0" or "1" that have to be left out when dialing with country code
clear() - Method in class org.ogema.tools.memoryschedules.tools.SampledValueSortedList
Empties the list.
clockChanged(FrameworkClock.ClockChangedEvent) - Method in interface org.ogema.core.administration.FrameworkClock.ClockChangeListener
 
clone() - Method in class org.ogema.core.channelmanager.measurements.BooleanValue
 
clone() - Method in class org.ogema.core.channelmanager.measurements.ByteArrayValue
 
clone() - Method in class org.ogema.core.channelmanager.measurements.DoubleValue
 
clone() - Method in class org.ogema.core.channelmanager.measurements.FloatValue
 
clone() - Method in class org.ogema.core.channelmanager.measurements.IntegerValue
 
clone() - Method in class org.ogema.core.channelmanager.measurements.LongValue
 
clone() - Method in class org.ogema.core.channelmanager.measurements.ObjectValue
 
clone() - Method in class org.ogema.core.channelmanager.measurements.StringValue
 
clone() - Method in interface org.ogema.core.channelmanager.measurements.Value
Creates a copy of this.
clone() - Method in interface org.ogema.tools.timeseries.api.MemoryTimeSeries
Create a copy of this.
clone() - Method in class org.ogema.tools.timeseries.implementations.ArrayTimeSeries
 
clone() - Method in class org.ogema.tools.timeseries.implementations.SynchronizedTimeSeries
 
clone() - Method in class org.ogema.tools.timeseries.implementations.TreeTimeSeries
 
co2Sensor() - Method in interface org.ogema.model.locations.Room
CO2 level in room atmosphere
CO2Sensor - Interface in org.ogema.model.sensors
CO2 sensor
ColourResource - Interface in org.ogema.core.model.units
Represents colour as an RGB value.
comAddress() - Method in interface org.ogema.model.communication.CommunicationInformation
Address(es) on which device can be contacted
comAddress() - Method in interface org.ogema.model.communication.ModbusCommunicationInformation
Modbus communication address
CombinedHeatAndPowerGenerator - Interface in org.ogema.model.devices.generators
Combined heat and power generator.
commit() - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
Execute the operations that have previously been added to the transaction, including all resource write operations (see e.g.
commit() - Method in interface org.ogema.tools.resourcemanipulator.configurations.ManipulatorConfiguration
Adds the manipulator to the system and starts it.
communicationAddress() - Method in interface org.ogema.model.communication.CommunicationInformation
Communication address to be used for upper-level identification/user interface.
communicationDisabled() - Method in interface org.ogema.model.communication.CommunicationStatus
communication does not work due to some configuration
communicationDisturbed() - Method in interface org.ogema.model.communication.CommunicationStatus
communication does not work properly or not at all, reason unknown
CommunicationInformation - Interface in org.ogema.model.communication
Information about a communication channel to an extern source, like a connected device or a web-server providing information.
communicationStatus() - Method in interface org.ogema.model.communication.CommunicationInformation
Current status of the communication.
CommunicationStatus - Interface in org.ogema.model.communication
Description of the current status of some communication channel.
compareTo(SampledValue) - Method in class org.ogema.core.channelmanager.measurements.SampledValue
Compares the timestampt of this with another sampled value's timestamp.
compareTo(TimeInterval) - Method in class org.ogema.tools.timeseries.api.TimeInterval
 
CompoundResourceEvent<T> - Interface in org.ogema.core.resourcemanager
Compound event that includes all types of resource events.
CompoundResourceEvent.CompoundEventType - Enum in org.ogema.core.resourcemanager
 
ConcentrationRange - Interface in org.ogema.model.ranges
 
ConcentrationResource - Interface in org.ogema.core.model.units
Resource representing a concentration of a substance in another substance.
ConcentrationTargetRange - Interface in org.ogema.model.targetranges
 
conductivity() - Method in interface org.ogema.model.connections.ThermalBridge
Thermal conductivity of the connection in W/K.
conductivity() - Method in interface org.ogema.model.connections.ThermalConnection
Thermal conductivity of the connection in W/K.
Configuration - Interface in org.ogema.model.prototypes
Prototype for configuration resources.
connect() - Method in interface org.ogema.core.installationmanager.ApplicationSource
Establishes a connection to the ApplicationSource.
connectAppSource(String) - Method in interface org.ogema.core.installationmanager.SourcesManagement
Connect to AppStore or to local directory containing apps.
connection() - Method in interface org.ogema.model.devices.buildingtechnology.Thermostat
Deprecated.
The thermal connection now is contained in valve.connection.
connection() - Method in interface org.ogema.model.devices.connectiondevices.ElectricityCircuitBreaker
 
connection() - Method in interface org.ogema.model.devices.connectiondevices.ElectricityConnectionBox
 
connection() - Method in interface org.ogema.model.devices.connectiondevices.GenericCircuitBreaker
The connection this breaker operates on.
connection() - Method in interface org.ogema.model.devices.connectiondevices.GenericConnectionBox
The connection that this box represents and acts on.
connection() - Method in interface org.ogema.model.devices.connectiondevices.HeatConnectionBox
 
connection() - Method in interface org.ogema.model.devices.connectiondevices.ThermalValve
The thermal connection that is influenced by the settings of the valve.
connection() - Method in interface org.ogema.model.metering.ElectricityMeter
Electricity connection
connection() - Method in interface org.ogema.model.metering.GenericMeter
Connection for measured commodity
connection() - Method in interface org.ogema.model.metering.HeatMeter
 
Connection - Interface in org.ogema.model.prototypes
Defines a connection between two physical objects.
connectionType() - Method in interface org.ogema.model.connections.ElectricityConnection
connection type:
1: fixed connection
2: plug, usually connected
3: plug, frequently disconnected (e.g. device connected via a manual switch)
4: plug, connected at various places (e.g. vacuum cleaner)
ConstantFloatAddition - Class in org.ogema.tools.timeseries.algebra
Adds a constant to a SampledValue of type FloatValue
ConstantFloatAddition(float) - Constructor for class org.ogema.tools.timeseries.algebra.ConstantFloatAddition
 
ConstantFloatMultiplication - Class in org.ogema.tools.timeseries.algebra
Multiplies a SampledValue with a constant factor.
ConstantFloatMultiplication(float) - Constructor for class org.ogema.tools.timeseries.algebra.ConstantFloatMultiplication
 
contains(Resource) - Method in interface org.ogema.core.model.ResourceList
Tests whether this list contains a given resource by comparing resource locations (see Resource.equalsLocation(org.ogema.core.model.Resource)).
contains(StringArrayResource, String) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Check if the array resource contains a String.
contains(FloatArrayResource, float, float) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Check if the array resource contains a float value.
contains(IntegerArrayResource, int) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Check if the array resource contains an int value.
contains(TimeArrayResource, long) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Check if the array resource contains a long value.
containsGridFees() - Method in interface org.ogema.model.smartgriddata.Price
If true the price contains grid fees, if false grid fees have to be added
containsTaxes() - Method in interface org.ogema.model.smartgriddata.Price
If true the price contains taxes, if false taxes have be added
ContextSensitivePattern<DemandedModel extends Resource,C> - Class in org.ogema.core.resourcemanager.pattern
A version of the ResourcePattern that allows to pass a context (which can be any object) to the pattern immediately after calling the constructor.
controllable() - Method in interface org.ogema.model.actors.Actor
Flag that indicates if the actor can be controlled by the gateway at all.
controlLimits() - Method in interface org.ogema.model.targetranges.AngleTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.BinaryTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.BrightnessTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.ConcentrationTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.ElectricCurrentTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.EnergyPerAreaTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.EnergyTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.FlowTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.FrequencyTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.GenericFloatTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.LuminousFluxTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.PowerTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.TargetRange
Limits for the sensor value that shall be used for the control of the relevant device.
controlLimits() - Method in interface org.ogema.model.targetranges.TemperatureTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.TimeTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.VelocityTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.VoltageTargetRange
 
controlLimits() - Method in interface org.ogema.model.targetranges.VolumeTargetRange
 
CookingPlate - Interface in org.ogema.model.devices.whitegoods
Cooking plate.
CoolingDevice - Interface in org.ogema.model.devices.whitegoods
Fridge, Freezer (any device with a single cold storage).
copy(Resource, Resource, ResourceAccess) - Static method in class org.ogema.tools.resource.util.ResourceUtils
Copy the source resource to target, including all subresources, with default settings (schedule values are copied, the active state is copied, logging is not activated for the new resources)
copy(Resource, Resource, ResourceAccess, ResourceCopyConfiguration) - Static method in class org.ogema.tools.resource.util.ResourceUtils
Copy the source resource to target, including all subresources.
copyDefensively() - Method in class org.ogema.core.channelmanager.measurements.SampledValue
This is similar to a #clone-method, but returns the same instance if the value field has a primitive value (i.e. is of type FloatValue, DoubleValue, IntegerValue, LongValue, BooleanValue, or StringValue).
count() - Method in interface org.ogema.model.communication.ModbusAddress
Number of registers
CountDownAbsoluteTimer - Class in org.ogema.tools.resourcemanipulator.timer
Implementation of a Count-Down timer: An OGEMA timer that evaluates exactly once (in contrast to the default periodic timer in OGEMA, that will continue with the next count down).
CountDownAbsoluteTimer(ApplicationManager, long, TimerListener) - Constructor for class org.ogema.tools.resourcemanipulator.timer.CountDownAbsoluteTimer
Create and start CountDownAbsoluteTimer
CountDownAbsoluteTimer(ApplicationManager, long, boolean, TimerListener) - Constructor for class org.ogema.tools.resourcemanipulator.timer.CountDownAbsoluteTimer
 
CountDownDelayedExecutionTimer - Class in org.ogema.tools.resourcemanipulator.timer
Implementation of a Count-Down timer: An OGEMA timer that after creation calls delayedExecution and afterwards is destroyed.
CountDownDelayedExecutionTimer(ApplicationManager, long) - Constructor for class org.ogema.tools.resourcemanipulator.timer.CountDownDelayedExecutionTimer
Time starts automatically after construction
CountDownTimer - Class in org.ogema.tools.resourcemanipulator.timer
Implementation of a Count-Down timer: An OGEMA timer that after start counts down the timer time and then evaluates exactly once (in contrast to the default periodic timer in OGEMA, that will continue with the next count down).
CountDownTimer(ApplicationManager, long, TimerListener) - Constructor for class org.ogema.tools.resourcemanipulator.timer.CountDownTimer
Note: The timer is not started automatically after construction, only after call of start
countryCode() - Method in interface org.ogema.model.stakeholders.PhoneNumber
Country code without starting "00" or "++"
create() - Method in interface org.ogema.core.model.Resource
Creates the resource.
create(Resource) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
Create a resoure in the transaction.
createConfiguration(Class<T>) - Method in interface org.ogema.tools.resourcemanipulator.ResourceManipulator
Creates a new instance of a configuration for a rule.
createConfiguration(Class<T>) - Method in class org.ogema.tools.resourcemanipulator.ResourceManipulatorImpl
 
createFromJson(String) - Method in interface org.ogema.core.tools.SerializationManager
 
createFromJson(Reader) - Method in interface org.ogema.core.tools.SerializationManager
 
createFromJson(Reader, Resource) - Method in interface org.ogema.core.tools.SerializationManager
 
createFromJson(String, Resource) - Method in interface org.ogema.core.tools.SerializationManager
 
createFromXml(Reader) - Method in interface org.ogema.core.tools.SerializationManager
 
createFromXml(String) - Method in interface org.ogema.core.tools.SerializationManager
Create the resource described in the XML document as a new top level resource.
createFromXml(Reader, Resource) - Method in interface org.ogema.core.tools.SerializationManager
 
createFromXml(String, Resource) - Method in interface org.ogema.core.tools.SerializationManager
Add the resource described in the XML document as a new subresource of the given parent resource.
createFunction(Function<Long, N>, int, long, long) - Static method in class org.ogema.tools.resource.util.TimeSeriesUtils
Create a time series based on a Function.
createInstallableApp(String, String) - Method in interface org.ogema.core.installationmanager.InstallationManagement
Create an InstallableApplication instance with the given address and name information.
createInstallableApp(Bundle) - Method in interface org.ogema.core.installationmanager.InstallationManagement
Creates an InstallableApplication object to an already installed application.
createOptionalResourceFields(P, Class<P>, boolean) - Method in interface org.ogema.core.resourcemanager.pattern.ResourcePatternAccess
Creates all optional resource fields of a pattern instance.
createRandomTimeSeries(int, long, long, boolean) - Static method in class org.ogema.tools.resource.util.TimeSeriesUtils
Create a time series with random float values, in the value range 0..1.
createRandomTimeSeries(int, long, long, boolean, Number, Number) - Static method in class org.ogema.tools.resource.util.TimeSeriesUtils
Create a time series with random values.
createResource(String, Class<P>) - Method in interface org.ogema.core.resourcemanager.pattern.ResourcePatternAccess
TODO
createResource(String, Class<P>, C) - Method in interface org.ogema.core.resourcemanager.pattern.ResourcePatternAccess
 
createResource(String, Class<T>) - Method in interface org.ogema.core.resourcemanager.ResourceManagement
Create a new resource The resource is added instantly to the framework.
createResource(Class<T>) - Method in class org.ogema.tools.resourcemanipulator.ResourceManipulatorImpl
Creates an empty configuration of the given type and sets the APP-ID
createResourcesFromJson(String) - Method in interface org.ogema.core.tools.SerializationManager
Add the resources described in the Json document as new toplevel resources
createResourcesFromJson(Reader) - Method in interface org.ogema.core.tools.SerializationManager
Add the resources described in the Json document as new toplevel resources
createResourcesFromJson(String, Resource) - Method in interface org.ogema.core.tools.SerializationManager
Add the resources described in the JSON document as new subresources of the given parent resource.
createResourcesFromJson(Reader, Resource) - Method in interface org.ogema.core.tools.SerializationManager
Add the resources described in the JSON document as new subresources of the given parent resource.
createResourcesFromXml(String) - Method in interface org.ogema.core.tools.SerializationManager
Add the resources described in the XML document as new toplevel resources
createResourcesFromXml(Reader) - Method in interface org.ogema.core.tools.SerializationManager
Add the resources described in the XML document as new toplevel resources
createResourcesFromXml(String, Resource) - Method in interface org.ogema.core.tools.SerializationManager
Add the resources described in the XML document as new subresources of the given parent resource.
createResourcesFromXml(Reader, Resource) - Method in interface org.ogema.core.tools.SerializationManager
Add the resources described in the XML document as new subresources of the given parent resource.
createResourceTransaction() - Method in interface org.ogema.core.resourcemanager.ResourceAccess
Creates and returns a new transaction object that can be used to perform multiple changes to the resource graph as an atomic operation.
createStepFunction(int, long, long, Number, Number) - Static method in class org.ogema.tools.resource.util.TimeSeriesUtils
Create a step function.
createStepFunction(int, long, long, boolean, Number, Number, boolean) - Static method in class org.ogema.tools.resource.util.TimeSeriesUtils
Create a step function.
createTimer(long, TimerListener) - Method in interface org.ogema.core.application.ApplicationManager
Create and start a timer.
createTimer(long) - Method in interface org.ogema.core.application.ApplicationManager
Create and start a timer.
createTransaction() - Method in interface org.ogema.core.resourcemanager.ResourceAccess
Deprecated. 
createUser(String, String, String, String) - Method in interface org.ogema.core.administration.CredentialStore
Create a user on a gateway.
createUserAccount(String, boolean) - Method in interface org.ogema.core.administration.AdministrationManager
Creates a new user account with the specified name.
createValue(Number) - Static method in class org.ogema.tools.resource.util.TimeSeriesUtils
Create a Value from a Number.
CredentialStore - Interface in org.ogema.core.administration
Interface to the management of the credentials of users.
currency() - Method in interface org.ogema.model.smartgriddata.Price
ISO 4217
currentSensor() - Method in interface org.ogema.model.connections.ElectricityConnection
current sensor
cutOffCurrent() - Method in interface org.ogema.model.devices.connectiondevices.ElectricityCircuitBreaker
 
cutOffCurrent() - Method in interface org.ogema.model.devices.connectiondevices.GenericCircuitBreaker
Current at which circuit breaker cuts circuit.
cycles() - Method in interface org.ogema.model.devices.storage.ElectricityStorage
Number of charge cycles so far.
A B C D E F G H I K L M N O P Q R S T U V W Z 
Skip navigation links