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

Class StateDataFunction

java.lang.Object

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

org.openmuc.jeebus.spine.spi.function.ReadSingleFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisStateDataType,org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType,DataFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisStateDataType,org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType>>

org.openmuc.jeebus.spine.utils.features.devicediagnosis.StateDataFunction

All Implemented Interfaces:

java.lang.AutoCloseable, Shutdownable

public class StateDataFunction
extends ReadSingleFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisStateDataType,org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType,DataFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisStateDataType,org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType>>

Field Summary

Fields

Modifier and Type	Field	Description
protected static org.slf4j.Logger	logger
static DataFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisStateDataType,org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType>	TYPE_INFO

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

Constructor Summary

Constructors

Constructor	Description
StateDataFunction()

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.DeviceDiagnosisStateDataType data)	Validates the given data.
protected void	validateReadCmd(org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType elementsType, 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

TYPE_INFO

public static final DataFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisStateDataType,org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType> TYPE_INFO

logger

protected static final org.slf4j.Logger logger

Constructor Detail

StateDataFunction

public StateDataFunction()

Method Detail

validateReadCmd

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

Specified by:

validateReadCmd in class ReadSingleFeatureFunction<org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisStateDataType,org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType,DataFeatureFunctionTypeInfo<org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisStateDataType,org.openmuc.jeebus.spine.xsd.v1.DeviceDiagnosisServiceDataElementsType>>

Throws:

SpineException

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

validateData

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

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.