Package org.openmuc.jeebus.spine.utils.features.loadcontrol

Class LoadControlFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS>

java.lang.Object

org.openmuc.jeebus.spine.spi.function.FeatureFunction

org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS,TYPE>

org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS,ListFeatureFunctionTypeInfo<DATA,DATA_LIST,SELECTOR,ELEMENTS>>

org.openmuc.jeebus.spine.utils.features.loadcontrol.LoadControlFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS>

All Implemented Interfaces:

java.lang.AutoCloseable, Shutdownable

Direct Known Subclasses:

EventListDataFunction, LimitConstraintsDataFunction, LimitDescriptionFunction, LimitListDataFunction, StateListDataFunction

public abstract class LoadControlFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS>
extends ReadAndWriteListFeatureFunction<DATA,DATA_LIST,SELECTOR,ELEMENTS,ListFeatureFunctionTypeInfo<DATA,DATA_LIST,SELECTOR,ELEMENTS>>

Field Summary

Fields

Modifier and Type	Field	Description
protected LoadControlFeature	feature
protected static org.slf4j.Logger	logger

Fields inherited from class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction

useCaseWriteDataListListener

Fields inherited from class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction

allowedReadListCmdOptions, dataListHolder, listFeatureFunctionNotifier

Method Summary

Modifier and Type	Method	Description
TYPE	getTypeInfo()
DataValidation<DATA>	getUseCaseDataValidation()
void	setUseCaseDataValidation(DataValidation<DATA> useCaseDataValidation)
protected abstract void	validateData(DATA data)	Validates the given data.
void	validateIsRemoteControllable()

Methods inherited from class org.openmuc.jeebus.spine.spi.function.ReadAndWriteListFeatureFunction

deleteDataEntriesBySelector, getAllowedWriteCmdOptions, setAllowedWriteCmdOptions, setUseCaseMatchingDataWriteValidation, setUseCaseWriteDataListener, setUseCaseWriteValidationFull, validateUpdateForMatchingData, validateWriteCmdFull, write, writeData

Methods inherited from class org.openmuc.jeebus.spine.spi.function.ReadListFeatureFunction

addData, addData, close, getAllowedReadCmdOptions, getDataCopies, getDataCopiesFor, getDataCopy, getDataCopyForFirst, read, removeData, removeData, setAllowedReadCmdOptions, setFeature, setUseCaseReadValidation, updateData, updateData, validateReadCmd

Methods inherited from class org.openmuc.jeebus.spine.spi.function.FeatureFunction

bindingRequired, call, getFunctionName, getFunctionProperty, isCallable, isReadable, isWritable, matchAddress, requireBinding, setCallable, setReadable, setWritable

Methods inherited from class java.lang.Object

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

Field Detail

feature

protected final LoadControlFeature feature

logger

protected static final org.slf4j.Logger logger

Method Detail

validateIsRemoteControllable

public void validateIsRemoteControllable()
                                  throws SpineException

Throws:

SpineException

getUseCaseDataValidation

public DataValidation<DATA> getUseCaseDataValidation()

setUseCaseDataValidation

public void setUseCaseDataValidation(DataValidation<DATA> useCaseDataValidation)

validateData

protected abstract void validateData(DATA data)
                              throws DataValidationException

Validates the given data. Must be implemented by the specific Feature Function.

Parameters:

data - the data to validate

Throws:

DataValidationException - if the validation fails

getTypeInfo

public TYPE getTypeInfo()