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

Class NodeDataFunction

java.lang.Object

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

org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataType,org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataElementsType,DataFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataType,org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataElementsType>>

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

All Implemented Interfaces:

java.lang.AutoCloseable, Shutdownable

public class NodeDataFunction
extends ReadSingleFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataType,org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataElementsType,DataFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataType,org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataElementsType>>

Field Summary

Fields

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

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

allowedReadCmdOptions, data, dataLock

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

feature

Method Summary

Modifier and Type	Method	Description
SpineAcknowledgment	call(org.openmuc.jeebus.spine.xsd.v1.CmdType cmd, org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType sourceAddress)
void	close()	Cleanly and promptly shut down this object, as well as all child objects and objects depending on this one.
TYPE	getTypeInfo()
DataValidation<DATA>	getUseCaseDataValidation()
void	setUseCaseDataValidation(DataValidation<DATA> useCaseDataValidation)
protected void	validateData(org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataType data)	Validates the given data.
protected void	validateReadCmd(org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataElementsType loadControlNodeDataElementsType, ReadSingleCmdOption readListCmdOption)

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

getAllowedReadCmdOptions, getDataCopy, read, setAllowedReadCmdOptions, setUseCaseReadSingleDataValidation, updateData, write

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

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

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

Method Detail

validateData

protected void validateData(org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataType 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

call

public SpineAcknowledgment call(org.openmuc.jeebus.spine.xsd.v1.CmdType cmd,
                                org.openmuc.jeebus.spine.xsd.v1.FeatureAddressType sourceAddress)

Specified by:

call in class FeatureFunction

Parameters:

cmd - the command data belonging to this function call

sourceAddress - the feature address of the client feature

Returns:

an acknowledgment stating the result of the operation

validateReadCmd

protected void validateReadCmd(org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataElementsType loadControlNodeDataElementsType,
                               ReadSingleCmdOption readListCmdOption)
                        throws SpineException

Specified by:

validateReadCmd in class ReadSingleFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataType,org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataElementsType,DataFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataType,org.openmuc.jeebus.spine.xsd.v1.LoadControlNodeDataElementsType>>

Throws:

SpineException

getUseCaseDataValidation

public DataValidation<DATA> getUseCaseDataValidation()

setUseCaseDataValidation

public void setUseCaseDataValidation(DataValidation<DATA> useCaseDataValidation)

getTypeInfo

public TYPE getTypeInfo()

close

public void close()

Description copied from interface: Shutdownable

Cleanly and promptly shut down this object, as well as all child objects and objects depending on this one.