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 

S

SampledValue - Class in org.ogema.core.channelmanager.measurements
Represents a sampled value.
SampledValue(SampledValue) - Constructor for class org.ogema.core.channelmanager.measurements.SampledValue
Copy constructor: Attempts to create a copy of another SampledValue, including a copy of all fields contained in the other value.
SampledValue(Value, long, Quality) - Constructor for class org.ogema.core.channelmanager.measurements.SampledValue
Creates a new SampledValue that wraps a given measurement value with a timestamp and an associated quality.
SampledValueContainer - Class in org.ogema.core.channelmanager.driverspi
A Container for SampledValues.
SampledValueContainer(ChannelLocator) - Constructor for class org.ogema.core.channelmanager.driverspi.SampledValueContainer
Constructor
SampledValueDataPoint - Interface in org.ogema.tools.timeseries.iterator.api
A special data point for time series.
SampledValueSortedList - Class in org.ogema.tools.memoryschedules.tools
Sorted list of SampledValues with SortedSet-like access methods.
SampledValueSortedList() - Constructor for class org.ogema.tools.memoryschedules.tools.SampledValueSortedList
Creates an empty list.
saveCache() - Method in interface org.ogema.core.logging.OgemaLogger
Demands the current cache to be persistently saved for future inpection.
Schedule - Interface in org.ogema.core.model.schedule
A schedule contains data that is relevant for the future behavior of the resource to which it is attached.
ScheduleManagement - Interface in org.ogema.tools.resourcemanipulator.configurations
Application tool that manages old schedule data.
ScheduleSum - Interface in org.ogema.tools.resourcemanipulator.configurations
Automatically-evaluated sum mapping {inputs} -> sum({inputs}) = result.
scope() - Method in interface org.ogema.model.smartgriddata.Price
Price type:
1: commodity market price
2: wholesale buying price
3: general retail price
4: specific customer price for billing
5: tariff stage of a multi-rate retail tariff.
selfDischargeRate() - Method in interface org.ogema.model.devices.storage.EnergyStorage
Self discharge rate at full charge.
sensor() - Method in interface org.ogema.model.devices.profiles.Profile
(Reference to) the sensor that represents the quantity modeled by this profile
Sensor - Interface in org.ogema.model.sensors
Prototype to be extended by resources representing a sensor or a measured property.
SensorDevice - Interface in org.ogema.model.devices.sensoractordevices
A single device containing one or multiple sensors.
sensors() - Method in interface org.ogema.model.devices.sensoractordevices.SensorDevice
The sensors contained in the device.
sensorType() - Method in interface org.ogema.model.sensors.SolarIrradiationSensor
Type of temperature correlation 0: real solar irradiation
1: solar irradiation values are adapted according to electricity generation capability of solar panels based on temperature (and possible further influence)
SerialHardwareDescriptor - Interface in org.ogema.core.hardwaremanager
The HardwareDescriptor subclass for Serial Ports (UARTs).
SerializationManager - Interface in org.ogema.core.tools
The SerializationManager provides methods to serialize Java objects, particularly OGEMA-specific ones, to text strings.
SerializationUtils - Class in org.ogema.tools.resource.util
Utility methods for de-/serialization of resources.
setActivationControl(boolean) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ScheduleSum
Sets the behavior of the manipulator rule with respect to activating and de-activating the result schedule.
setAddends(Collection<Schedule>, Schedule) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ScheduleSum
Sets the list of addends and the target resource where the result is written to.
setAddends(Collection<? extends SingleValueResource>, SingleValueResource) - Method in interface org.ogema.tools.resourcemanipulator.configurations.Sum
Sets the list of addends and the target resource where the result is written to.
setAnd() - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesBuilder
For boolean time series.
setAppid(AppID) - Method in interface org.ogema.core.installationmanager.InstallableApplication
Sets the AppID object.
setAsReference(T) - Method in interface org.ogema.core.model.Resource
Replace this resource, which must be an optional element of its parent, with a reference.
setAsReference(R, R) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
Set a reference from resource to target (see Resource.setAsReference(Resource)).
setAverage() - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesBuilder
For float time series.
setBoolean(BooleanResource, boolean) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setBoolean(BooleanResource, boolean, WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setBoolean(BooleanResource, boolean) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setBooleanArray(BooleanArrayResource, boolean[]) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setBooleanArray(BooleanArrayResource, boolean[], WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setBooleanArray(BooleanArrayResource, boolean[]) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setBundle(Bundle) - Method in interface org.ogema.core.installationmanager.InstallableApplication
Sets the reference of the Bundle that belongs to the application.
setByteArray(ByteArrayResource, byte[]) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setByteArray(ByteArrayResource, byte[], WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setByteArray(OpaqueResource, byte[]) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
Type OpaqueResource is deprecated. Use ByteArrayResource instead.
setByteArray(ByteArrayResource, byte[]) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setCelsius(float) - Method in interface org.ogema.core.model.units.TemperatureResource
Sets the new temperature in Celsius.
setChannelValue(ChannelConfiguration, Value) - Method in interface org.ogema.core.channelmanager.ChannelAccess
Set the value of a single channel.
setConfiguration(RecordedDataConfiguration) - Method in interface org.ogema.core.recordeddata.RecordedData
Configure automated writing of values from the parent resource into the database.
setConstant(float) - Method in interface org.ogema.tools.timeseries.api.FloatTimeSeries
Sets this to a TimeSeries that has the given value for all times.
setConstant(float) - Method in class org.ogema.tools.timeseries.implementations.FloatTreeTimeSeries
 
setContext(S) - Method in interface org.ogema.tools.timeseries.iterator.api.DataPoint
This is a convenience method that allows users of the interface to store context data for a DataPoint.
setCopyActivationState(boolean) - Method in class org.ogema.tools.resource.util.ResourceCopyConfigurationBuilder
Activate resources if the corresponding source resource is active?
setCopyLoggingState(boolean) - Method in class org.ogema.tools.resource.util.ResourceCopyConfigurationBuilder
Activate logging if logging is enabled for the source resource?
setCopyReferences(boolean) - Method in class org.ogema.tools.resource.util.ResourceCopyConfigurationBuilder
Copy references (set reference to same target resource as for the source resource) ?
setCopyScheduleValues(boolean) - Method in class org.ogema.tools.resource.util.ResourceCopyConfigurationBuilder
Copy schedule values to new schedule resources?
setCubicMeterPerHour(float) - Method in interface org.ogema.core.model.units.FlowResource
Sets the value in m³/h.
setDelay(long) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ScheduleSum
Sets a delay time between changes in the inputs and the evaluation of the output.
setDelay(long) - Method in interface org.ogema.tools.resourcemanipulator.configurations.Sum
Sets a delay time between changes in the inputs and the evaluation of the output.
setDisableEmptySum(boolean) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ScheduleSum
Deprecated.
Definition of this was inconsistent, since inactive resources would not be re-activated. Use ScheduleSum.setActivationControl(boolean), instead.
setDisableEmptySum(boolean) - Method in interface org.ogema.tools.resourcemanipulator.configurations.Sum
Sets the behavior with respect to empty sums.
setElementType(Class<? extends Resource>) - Method in interface org.ogema.core.model.ResourceList
Set type of resources in the list (relevant for top-level lists or lists added as decorator only)
setElementValue(boolean, int) - Method in interface org.ogema.core.model.array.BooleanArrayResource
Sets the value of a single element in the array.
setElementValue(byte, int) - Method in interface org.ogema.core.model.array.ByteArrayResource
Sets the value of a single element in the array.
setElementValue(float, int) - Method in interface org.ogema.core.model.array.FloatArrayResource
Sets the value of a single element in the array.
setElementValue(int, int) - Method in interface org.ogema.core.model.array.IntegerArrayResource
Sets the value of a single element in the array.
setElementValue(String, int) - Method in interface org.ogema.core.model.array.StringArrayResource
Sets the value of a single element in the array.
setElementValue(long, int) - Method in interface org.ogema.core.model.array.TimeArrayResource
Sets the value of a single element in the array.
setEqualityExceeds(boolean) - Method in interface org.ogema.tools.resourcemanipulator.configurations.Threshold
Sets the handing of equality of the resource and the threshold.
setExcludedRelativePaths(List<String>) - Method in class org.ogema.tools.resource.util.ResourceCopyConfigurationBuilder
Exclude certain relative paths from the copy operation?
setExcludedResourceTypes(List<Class<? extends Resource>>) - Method in class org.ogema.tools.resource.util.ResourceCopyConfigurationBuilder
Exclude certain resource types from the copy operation?
setFixedInterval(long) - Method in class org.ogema.core.recordeddata.RecordedDataConfiguration
Setter for the fixed time interval for storage type FIXED_INTERVAL
setFloat(FloatResource, float) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
Sets the value for the resource that shall be written in the transaction.
setFloat(FloatResource, float, WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
Sets the value for the resource that shall be written in the the transaction.
setFloat(FloatResource, float) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
Sets the value for the resource that shall be written in the next write transaction.
setFloatArray(FloatArrayResource, float[]) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setFloatArray(FloatArrayResource, float[], WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setFloatArray(FloatArrayResource, float[]) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setFollowReferences(boolean) - Method in interface org.ogema.core.tools.SerializationManager
Sets the behavior with regards to following references during serialization.
setFunction(Function<Collection<N>, N>) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesBuilder
Define how to calculate the values of the multi time series from the values of the underlying time series.
setGlobalInterpolationMode(InterpolationMode) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesIteratorBuilder
Set a common interpolation mode for all time series in iterations that need interpolation (e.g. if the values are averaged, or fixed step size is configured).
setGlobalMode(InterpolationMode) - Method in class org.ogema.tools.timeseries.iterator.api.ReductionIteratorBuilder
 
setGrantedPermissions(AppPermission) - Method in interface org.ogema.core.installationmanager.InstallableApplication
Sets the AppPermission object which hold a set of permissions that are to be granted to the application.
setGWPassword(String, String, String) - Method in interface org.ogema.core.administration.CredentialStore
Change the gateway password of the user.
setHexadecimal(String) - Method in interface org.ogema.core.model.units.ColourResource
Set the colour value in hexadecimal RGB representation, e.g.
setHSL(float[]) - Method in interface org.ogema.core.model.units.ColourResource
Set the colour value in HSL representation (hue, saturation, lightness).
setHSV(float[]) - Method in interface org.ogema.core.model.units.ColourResource
Set the colour value in HSV representation (hue, saturation, value).
setIgnoreGaps(boolean) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ScheduleSum
If this set to true, then the domain of the target schedule will be the union of the domains of the addends, i.e. the target schedule will contain a valid value whereever at least one of the constituents is defined.
setIgnoreGaps(boolean) - Method in class org.ogema.tools.timeseries.iterator.api.ReductionIteratorBuilder
 
setIncrementalUpdate(boolean) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ScheduleSum
If set to true, incremental updates will be performed, starting at the latest data point in the output schedule.
setIndividualInterpolationModes(List<InterpolationMode>) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesIteratorBuilder
Set an interpolation mode per time series in iterations that need interpolation (e.g. if the values are averaged, or fixed step size is configured).
setIndividualModes(List<InterpolationMode>) - Method in class org.ogema.tools.timeseries.iterator.api.ReductionIteratorBuilder
 
setInteger(IntegerResource, int) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setInteger(IntegerResource, int, WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setInteger(IntegerResource, int) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setIntegerArray(IntegerArrayResource, int[]) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setIntegerArray(IntegerArrayResource, int[], WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setIntegerArray(IntegerArrayResource, int[]) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setInterpolationMode(InterpolationMode) - Method in interface org.ogema.core.timeseries.TimeSeries
(Re-) defines how the schedule entries are to be interpreted.
setInterpolationMode(InterpolationMode) - Method in class org.ogema.tools.timeseries.implementations.ArrayTimeSeries
 
setInterpolationMode(InterpolationMode) - Method in class org.ogema.tools.timeseries.implementations.SynchronizedTimeSeries
 
setInterpolationMode(InterpolationMode) - Method in class org.ogema.tools.timeseries.implementations.TreeTimeSeries
 
setInterpolationModeForConstituents(InterpolationMode) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesBuilder
Calculate the multi time series values using the passed interpolation mode on the input time series, instead of their intrinsic interpolation modes.
setInterpolationModeForResult(InterpolationMode) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesBuilder
Set the interpolation mode for the resulting multi time series.
setInversion(boolean) - Method in interface org.ogema.tools.resourcemanipulator.configurations.Threshold
Sets the inversion flag, which is false by default.
setKelvin(float) - Method in interface org.ogema.core.model.units.TemperatureResource
Sets the new temperature in Kelvin.
setKWhs(float) - Method in interface org.ogema.core.model.units.EnergyResource
Set the energy in kWhs.
setLowerBoundaryValues(Map<Integer, SampledValue>) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesIteratorBuilder
Default value: null
setMax(int) - Method in class org.ogema.tools.memoryschedules.tools.IndexInterval
 
setMaxDepth(int) - Method in interface org.ogema.core.tools.SerializationManager
Configures the maximum depth of subresources parsed during the serialization.
setMaximumLogLevel(LogOutput, LogLevel) - Method in interface org.ogema.core.logging.OgemaLogger
Requests to set the maximum log level for the respective LogOutput.
setMaximumSize(LogOutput, long) - Method in interface org.ogema.core.administration.AdminLogger
Set the maximum size (in bytes) that a LogOutput may use.
setMaxNrHistoricalValues(int) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesIteratorBuilder
Default value: 0
setMin(int) - Method in class org.ogema.tools.memoryschedules.tools.IndexInterval
 
setMultipleChannelValues(List<ChannelConfiguration>, List<Value>) - Method in interface org.ogema.core.channelmanager.ChannelAccess
Set the values of multiple channels at once.
setNewPassword(String, String) - Method in interface org.ogema.core.administration.UserAccount
Change the password of the user associated with this account object.
setOptionalElement(String, Resource) - Method in interface org.ogema.core.model.Resource
Attach a resource as an optional element reference.
setOr() - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesBuilder
For boolean time series; this is the default setting.
setpoint() - Method in interface org.ogema.model.targetranges.AngleTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.BinaryTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.BrightnessTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.ConcentrationTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.ElectricCurrentTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.EnergyPerAreaTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.EnergyTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.FlowTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.FrequencyTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.GenericFloatTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.LuminousFluxTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.PowerTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.TargetRange
Control setpoint for the value.
setpoint() - Method in interface org.ogema.model.targetranges.TemperatureTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.TimeTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.VelocityTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.VoltageTargetRange
 
setpoint() - Method in interface org.ogema.model.targetranges.VolumeTargetRange
 
setpointNum() - Method in interface org.ogema.model.actors.MultiSwitch
Number of switchable steps.
setRangeFilter(float, float) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ProgramEnforcer
See ProgramEnforcerImpl.setRangeFilter(float, float, int).
setRangeFilter(float, float, int) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ProgramEnforcer
In order to activate only one of the boundaries, pass Float.NaN for the other one.
setSampledValue(SampledValue) - Method in class org.ogema.core.channelmanager.driverspi.SampledValueContainer
 
setSchedule(Schedule, ReadOnlyTimeSeries) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
Set the schedule content to a new function, that is written in the ResourceTransaction.commit() operation.
setSchedule(Schedule, ReadOnlyTimeSeries, WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
Set the schedule content to a new function, that is written in the ResourceTransaction.commit() operation.
setSchedule(Schedule, ReadOnlyTimeSeries) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
Set the schedule content to a new function, that is written in the Transaction.write() operation.
setSerializeSchedules(boolean) - Method in interface org.ogema.core.tools.SerializationManager
Defines whether sub-resources of type Schedule are serialized or not.
setSimulationFactor(float) - Method in interface org.ogema.core.administration.FrameworkClock
 
setSimulationTime(long) - Method in interface org.ogema.core.administration.FrameworkClock
Set the simulation time, in milliseconds since epoch
setSimulationTimeAndFactor(long, float) - Method in interface org.ogema.core.administration.FrameworkClock
setState(InstallableApplication.InstallState) - Method in interface org.ogema.core.installationmanager.InstallableApplication
Sets state of the application.
setStepSize(long, long) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesIteratorBuilder
Set a constant time interval for the iteration.
setStorageType(RecordedDataConfiguration.StorageType) - Method in class org.ogema.core.recordeddata.RecordedDataConfiguration
Setter method for the storage type to be used
setString(StringResource, String) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setString(StringResource, String, WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setString(StringResource, String) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setStringArray(StringArrayResource, String[]) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setStringArray(StringArrayResource, String[], WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setStringArray(StringArrayResource, String[]) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setSum() - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesBuilder
For float time series.
setTargetScheduleName(String) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ProgramEnforcer
Set a custom resource name for the schedule subresource (default: "program")
setThreshold(FloatResource, float, BooleanResource) - Method in interface org.ogema.tools.resourcemanipulator.configurations.Threshold
Set the threshold rule for target such that it is true exactly if the value of source exceed the threshold.
setThreshold(float) - Method in interface org.ogema.tools.resourcemanipulator.configurations.Threshold
Sets a threshold value
setTime(TimeResource, long) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setTime(TimeResource, long, WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setTime(TimeResource, long) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
 
setTimeArray(TimeArrayResource, long[]) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setTimeArray(TimeArrayResource, long[], WriteConfiguration) - Method in interface org.ogema.core.resourcemanager.transaction.ResourceTransaction
setTimeArray(TimeArrayResource, long[]) - Method in interface org.ogema.core.resourcemanager.Transaction
Deprecated.
setTimingInterval(long) - Method in interface org.ogema.core.application.Timer
(Re-)sets the length of the time interval between two timer callbacks.
setting() - Method in interface org.ogema.model.devices.buildingtechnology.Blind
Specifies the current state of the blind ( setting.stateFeedback : 0: open, 1: fully closed), as well as a setpoint if automatic control is possible.
setting() - Method in interface org.ogema.model.devices.buildingtechnology.ElectricDimmer
The dimming switch of the dimmer.
setting() - Method in interface org.ogema.model.devices.buildingtechnology.ElectricLight
Power setting for the light.
setting() - Method in interface org.ogema.model.devices.buildingtechnology.MechanicalFan
Power setting relative to maximum powers.
setting() - Method in interface org.ogema.model.devices.connectiondevices.ThermalValve
Switch position
If valve can only be shut or open, the valve should be open if set to more than 0.5
setting() - Method in interface org.ogema.model.devices.generators.CombinedHeatAndPowerGenerator
Combined power setting of heat and electricity as a ratio of the rated values.
setting() - Method in interface org.ogema.model.devices.generators.GenericEnergyGenerator
Switch rating for the power production, in case the device allows regulating the power production.
setting() - Method in interface org.ogema.model.devices.storage.ChargingPoint
Actor controlling the charging current.
setting() - Method in interface org.ogema.model.devices.storage.EnergyStorage
Setting for the total charging or discharging, as a share on EnergyStorage.ratedPower().
setting() - Method in interface org.ogema.model.devices.whitegoods.CookingPlate
Power setting for the plate.
setting() - Method in interface org.ogema.model.devices.whitegoods.CoolingDevice
Power setting.
setting() - Method in interface org.ogema.model.devices.whitegoods.FreezeCombi
Power setting.
settings() - Method in interface org.ogema.model.actors.Actor
Setting setpoints and target ranges that shall be achieved by energy management.
settings() - Method in interface org.ogema.model.actors.MultiSwitch
 
settings() - Method in interface org.ogema.model.actors.OnOffSwitch
 
settings() - Method in interface org.ogema.model.sensors.AngleSensor
 
settings() - Method in interface org.ogema.model.sensors.CO2Sensor
 
settings() - Method in interface org.ogema.model.sensors.ElectricCurrentSensor
 
settings() - Method in interface org.ogema.model.sensors.ElectricFrequencySensor
 
settings() - Method in interface org.ogema.model.sensors.ElectricVoltageSensor
 
settings() - Method in interface org.ogema.model.sensors.EnergyAccumulatedSensor
 
settings() - Method in interface org.ogema.model.sensors.FlowSensor
 
settings() - Method in interface org.ogema.model.sensors.GenericBinarySensor
 
settings() - Method in interface org.ogema.model.sensors.GenericFloatSensor
 
settings() - Method in interface org.ogema.model.sensors.GenericMultiSensor
Setpoint to reach via management.
settings() - Method in interface org.ogema.model.sensors.GeographicDirectionSensor
Direction settings.
settings() - Method in interface org.ogema.model.sensors.HumiditySensor
 
settings() - Method in interface org.ogema.model.sensors.LightSensor
 
settings() - Method in interface org.ogema.model.sensors.LuminousFluxSensor
 
settings() - Method in interface org.ogema.model.sensors.MotionSensor
Settings for motion status for EM-system.
settings() - Method in interface org.ogema.model.sensors.OccupancySensor
Settings for a room to be occupied
false: unoccupied true: occupied
settings() - Method in interface org.ogema.model.sensors.PowerSensor
 
settings() - Method in interface org.ogema.model.sensors.ReactivePowerAngleSensor
Setpoints for the sensor reading.
settings() - Method in interface org.ogema.model.sensors.Sensor
Control and alarm settings for the value that the management software should take into account.
settings() - Method in interface org.ogema.model.sensors.SolarIrradiationSensor
Settings for the reading.
settings() - Method in interface org.ogema.model.sensors.StateOfChargeSensor
Target settings as a state of charge (as in StateOfChargeSensor.reading()).
settings() - Method in interface org.ogema.model.sensors.TemperatureSensor
 
settings() - Method in interface org.ogema.model.sensors.TouchSensor
Sensor settings
true: sensor is being touched/pressed
false: sensor not being touched/pressed
settings() - Method in interface org.ogema.model.sensors.VelocitySensor
Settings for the velocity of the substance/gas.The direction of the positive sign must be defined in the parent resource.
settings() - Method in interface org.ogema.model.sensors.VolumeAccumulatedSensor
 
setUpdateInterval(long) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ScheduleManagement
 
setUpperBoundaryValues(Map<Integer, SampledValue>) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesIteratorBuilder
Default value: null
setValue(Value) - Method in class org.ogema.core.channelmanager.driverspi.ValueContainer
 
setValue(boolean) - Method in interface org.ogema.core.model.simple.BooleanResource
Sets the resource value to value.
setValue(float) - Method in interface org.ogema.core.model.simple.FloatResource
Sets the resource value to value.
setValue(int) - Method in interface org.ogema.core.model.simple.IntegerResource
Sets the resource value to value.
setValue(byte[]) - Method in interface org.ogema.core.model.simple.OpaqueResource
Deprecated.
Sets the resource data to a copy of the data passed
setValue(String) - Method in interface org.ogema.core.model.simple.StringResource
Sets a new text in the resource that equals a copy of the parameter passed.
setValue(long) - Method in interface org.ogema.core.model.simple.TimeResource
Sets the time difference
setValue(float) - Method in interface org.ogema.core.model.units.AngleResource
Sets the angle to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.AreaResource
Sets the area to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.BrightnessResource
Sets the brightness to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.ConcentrationResource
Sets the concentration to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.ElectricCurrentResource
Sets the current to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.ElectricResistanceResource
Sets the resistance to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.EnergyPerAreaResource
Sets the energy density to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.EnergyResource
Sets the energy to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.FlowResource
Sets the flow to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.FrequencyResource
Sets the frequency to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.LengthResource
Sets the length to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.LuminousFluxResource
Sets the light flow to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.MassResource
Sets the mass to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.PercentageResource
Sets the new value.
setValue(float) - Method in interface org.ogema.core.model.units.PowerResource
Sets the power to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.TemperatureResource
Sets the temperature to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.ThermalEnergyCapacityResource
Sets the capacity to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.VelocityResource
Sets the velocity to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.VoltageResource
Sets the voltage to a new value.
setValue(float) - Method in interface org.ogema.core.model.units.VolumeResource
Sets the volume to a new value.
setValue(ValueResource, Object) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Set the value of a ValueResource.
setValue(SingleValueResource, String) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Set the resource value.
setValue(SingleValueResource, float) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Set the resource value; the passed float value is converted by the respective canonical conversion method to the primitive (or String) value type of resource.
setValue(SingleValueResource, int) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Set the resource value; the passed integer value is converted by the respective canonical conversion method to the primitive (or String) value type of resource.
setValue(SingleValueResource, Value) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Set the resource value; the passed value is converted by the respective method of Value.
setValue(ArrayResource, int, Object) - Static method in class org.ogema.tools.resource.util.ValueResourceUtils
Replace one value of an ArrayResource or append one value to it.
setValues(boolean[]) - Method in interface org.ogema.core.model.array.BooleanArrayResource
Replace the represented array with a new one.
setValues(byte[]) - Method in interface org.ogema.core.model.array.ByteArrayResource
Replace the represented array with a new one.
setValues(float[]) - Method in interface org.ogema.core.model.array.FloatArrayResource
Replace the represented array with a new one.
setValues(int[]) - Method in interface org.ogema.core.model.array.IntegerArrayResource
Replace the represented array with a new one.
setValues(String[]) - Method in interface org.ogema.core.model.array.StringArrayResource
Replace the represented array with a new one.
setValues(long[]) - Method in interface org.ogema.core.model.array.TimeArrayResource
Replace the represented array with a new one.
setValues(float[]) - Method in interface org.ogema.core.model.units.ColourResource
Set the colour as an RGB value (red, green, blue).
setWaitForSchedules(boolean) - Method in interface org.ogema.tools.resourcemanipulator.configurations.ScheduleSum
If true, a new value is only written once all non-empty input schedules have a data point newer than the timestamp evaluated.
shiftTimestamps(long) - Method in interface org.ogema.tools.timeseries.api.MemoryTimeSeries
Shifts the timestamps of all entries by dT.
shiftTimestamps(long) - Method in class org.ogema.tools.timeseries.implementations.ArrayTimeSeries
 
shiftTimestamps(long) - Method in class org.ogema.tools.timeseries.implementations.SynchronizedTimeSeries
 
shiftTimestamps(long) - Method in class org.ogema.tools.timeseries.implementations.TreeTimeSeries
 
shortPress() - Method in interface org.ogema.model.actors.RemoteControl
When a button is pressed for a short time, the corresponding boolean subresource of this list shall be set to true, and immediately reset to false.
shutdown() - Method in interface org.ogema.core.application.ApplicationManager
Stop the application and shut down this application manager.
shutdown() - Method in interface org.ogema.core.channelmanager.driverspi.ChannelDriver
Shutdown the driver.
SimpleResource - Interface in org.ogema.core.model
Deprecated.
this marker interface was not defined in a useful manner. Use ValueResource and its specializations ArrayResource, Schedule and SingleValueResource, instead.
SIMULATION_FACTOR_CHANGED_PROPERTY - Static variable in interface org.ogema.core.administration.FrameworkClock
Deprecated.
SingleSwitchBox - Interface in org.ogema.model.devices.sensoractordevices
Device to be provided by hardware driver.
SingleValueResource - Interface in org.ogema.core.model.simple
Marker interface for resource types whose nodes contain a single value.
size() - Method in interface org.ogema.core.model.array.BooleanArrayResource
Returns the number of entries in the array.
size() - Method in interface org.ogema.core.model.array.ByteArrayResource
Returns the number of entries in the array.
size() - Method in interface org.ogema.core.model.array.FloatArrayResource
Returns the number of entries in the array.
size() - Method in interface org.ogema.core.model.array.IntegerArrayResource
Returns the number of entries in the array.
size() - Method in interface org.ogema.core.model.array.StringArrayResource
Returns the number of entries in the array.
size() - Method in interface org.ogema.core.model.array.TimeArrayResource
Returns the number of entries in the array.
size() - Method in interface org.ogema.core.model.ResourceList
Get number of elements in the list.
size() - Method in interface org.ogema.core.timeseries.ReadOnlyTimeSeries
Returns the number of data points in the time series.
size(long, long) - Method in interface org.ogema.core.timeseries.ReadOnlyTimeSeries
Returns the number of data points within the specified interval (both time stamps included)
size() - Method in class org.ogema.tools.memoryschedules.tools.IndexInterval
Returns the size of this interval.
size() - Method in class org.ogema.tools.memoryschedules.tools.SampledValueSortedList
Returns the size of the list.
size(long, long) - Method in class org.ogema.tools.memoryschedules.tools.SampledValueSortedList
 
size() - Method in class org.ogema.tools.timeseries.implementations.ArrayTimeSeries
 
size(long, long) - Method in class org.ogema.tools.timeseries.implementations.ArrayTimeSeries
 
size() - Method in class org.ogema.tools.timeseries.implementations.SynchronizedTimeSeries
 
size(long, long) - Method in class org.ogema.tools.timeseries.implementations.SynchronizedTimeSeries
 
size() - Method in class org.ogema.tools.timeseries.implementations.TreeTimeSeries
 
size(long, long) - Method in class org.ogema.tools.timeseries.implementations.TreeTimeSeries
 
size() - Method in class org.ogema.tools.timeseries.iterator.api.IteratorTimeSeries
 
size(long, long) - Method in class org.ogema.tools.timeseries.iterator.api.IteratorTimeSeries
 
size() - Method in interface org.ogema.tools.timeseries.iterator.api.MultiIterator
 
SmokeDetector - Interface in org.ogema.model.sensors
 
SolarIrradiationSensor - Interface in org.ogema.model.sensors
GenericFloatSensor measuring the solar energy irradiated on the target area.
SourcesManagement - Interface in org.ogema.core.installationmanager
 
speed() - Method in interface org.ogema.model.devices.sensoractordevices.WindSensor
Wind speed.
standardDisplay() - Method in interface org.ogema.model.stakeholders.PhoneNumber
Optionally also a string representation for the phone number may be given
standardLanguage() - Method in interface org.ogema.model.stakeholders.LegalEntity
Standard language to be used when communicating with legal entity
start(ApplicationManager) - Method in interface org.ogema.core.application.Application
This method is called by the framework when the application OSGi service is recognized and when all framework services are available.
start() - Method in interface org.ogema.tools.resourcemanipulator.ResourceManipulator
Starts the tool.
start(ApplicationManager) - Method in interface org.ogema.tools.resourcemanipulator.ResourceManipulator
Deprecated.
Current implementation passes application manager upon creation.
start() - Method in class org.ogema.tools.resourcemanipulator.ResourceManipulatorImpl
 
start(ApplicationManager) - Method in class org.ogema.tools.resourcemanipulator.ResourceManipulatorImpl
Deprecated.
start() - Method in class org.ogema.tools.resourcemanipulator.timer.CountDownDelayedExecutionTimer
Start the count down.
start() - Method in class org.ogema.tools.resourcemanipulator.timer.CountDownTimer
Start the count down.
startChannelScan(DeviceLocator, ChannelScanListener) - Method in interface org.ogema.core.channelmanager.driverspi.ChannelDriver
Discover available channels of a communication device.
startDeviceScan(String, String, DeviceScanListener) - Method in interface org.ogema.core.channelmanager.driverspi.ChannelDriver
Discover devices connected to a communication interface.
startTime() - Method in interface org.ogema.model.sensors.EnergyAccumulatedSensor
Time at which the integration started.
startTime() - Method in interface org.ogema.model.sensors.VolumeAccumulatedSensor
Time at which the integration started.
startTime() - Method in interface org.ogema.model.smartgriddata.GenericEnergyRequest
Starting time of the request.
startupTimeCold() - Method in interface org.ogema.model.devices.generators.GenericEnergyGenerator
start up time from cold start of energy generating unit to 90% of rated power
startupTimeWarm() - Method in interface org.ogema.model.devices.generators.GenericEnergyGenerator
start up time from warm start (output power just reduced to zero) to 90% of rated power
State - Interface in org.ogema.model.devices.profiles
State of a device, such as "Off", "On", "Stand-by".
stateControl() - Method in interface org.ogema.model.actors.Actor
Setting of the actor as set by the energy management software.
stateControl() - Method in interface org.ogema.model.actors.MultiSwitch
A value between 0 and 1 - both included - which specifies the currently selected switching setpoint.
stateControl() - Method in interface org.ogema.model.actors.OnOffSwitch
 
stateFeedback() - Method in interface org.ogema.model.actors.Actor
Device's feedback for the setting (if applicable).
stateFeedback() - Method in interface org.ogema.model.actors.MultiSwitch
The actual measured value.
stateFeedback() - Method in interface org.ogema.model.actors.OnOffSwitch
 
stateId() - Method in interface org.ogema.model.devices.profiles.State
A unique (per device) id
Use subresource name instead to specify a human-readable name for the state.
StateOfChargeSensor - Interface in org.ogema.model.sensors
Sensor measuring the state of charge of something in relative units, from 0.0 (uncharged) to 1.0 (fully charged).
states() - Method in interface org.ogema.model.prototypes.PhysicalElement
Steady states of this device, such as 'on', 'off', 'standby'.
StepInterpolation - Class in org.ogema.tools.timeseries.interpolation
Step interpolation: Always return a copy of x0.
StepInterpolation() - Constructor for class org.ogema.tools.timeseries.interpolation.StepInterpolation
 
stepSizeAsInSchedules(int[]) - Method in class org.ogema.tools.timeseries.iterator.api.MultiTimeSeriesIteratorBuilder
If stepRulers is set to a non-null value, the step size of the iteration will be determined by the points of the iterators corresponding to the indices in stepRulers.
StepsReductionAction - Class in org.ogema.tools.resourcemanipulator.schedulemgmt
For a time series with interpolation mode InterpolationMode.STEPS or InterpolationMode.NONE, delete all data points whose value and quality equal the previous ones.
StepsReductionAction(ApplicationManager) - Constructor for class org.ogema.tools.resourcemanipulator.schedulemgmt.StepsReductionAction
 
stop(Application.AppStopReason) - Method in interface org.ogema.core.application.Application
This method is called by the framework when the application shall be shutdown due to an request obtained via the user interface or due to a general framework shutdown.
stop() - Method in interface org.ogema.core.application.Timer
Stop generating callbacks.
stop() - Method in interface org.ogema.tools.resourcemanipulator.ResourceManipulator
Stops the manipulators.
stop() - Method in class org.ogema.tools.resourcemanipulator.ResourceManipulatorImpl
 
stop() - Method in class org.ogema.tools.resourcemanipulator.timer.CountDownDelayedExecutionTimer
Stops the count-down.
stop() - Method in class org.ogema.tools.resourcemanipulator.timer.CountDownTimer
Stops the count-down.
storageTemperature() - Method in interface org.ogema.model.devices.storage.ThermalStorage
Mean temperature of the thermal storage.
StringArrayResource - Interface in org.ogema.core.model.array
Resource type representing an array of strings.
StringResource - Interface in org.ogema.core.model.simple
Resource containing a single string entry.
StringValue - Class in org.ogema.core.channelmanager.measurements
StringValue
StringValue(String) - Constructor for class org.ogema.core.channelmanager.measurements.StringValue
 
StructureValueListener<T extends Resource> - Interface in org.ogema.tools.listener.util
A listener that is informed of both structure and value changes.
subject() - Method in interface org.ogema.model.time.CalendarEntry
Subject / title of the event.
submitEvent(Callable<T>) - Method in interface org.ogema.core.application.ApplicationManager
Submit event that will result into a callback to the application.
subPhaseConnections() - Method in interface org.ogema.model.connections.ElectricityConnection
In case of a multi-phase connection access to connection information of the single phases may be provided
subtract(long, long) - Static method in class org.ogema.tools.resourcemanipulator.schedulemgmt.TimeSeriesReduction
 
Sum - Interface in org.ogema.tools.resourcemanipulator.configurations
Automatically-evaluated sum mapping {inputs} -> sum({inputs}) = result.
switchboxes() - Method in interface org.ogema.model.devices.sensoractordevices.MultiSwitchBox
Set of the individual switch box units.
switchOffTime() - Method in interface org.ogema.model.devices.connectiondevices.GenericCircuitBreaker
Time until breaker switches off if cutOffCurrent or leakageCurrent is detected
SynchronizedTimeSeries - Class in org.ogema.tools.timeseries.implementations
Synchronized wrapper for a TimeSeries.
SynchronizedTimeSeries(MemoryTimeSeries) - Constructor for class org.ogema.tools.timeseries.implementations.SynchronizedTimeSeries
Wrapper constructor.
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