Class BatteryState
- java.lang.Object
-
- org.somda.sdc.biceps.model.participant.AbstractState
-
- org.somda.sdc.biceps.model.participant.AbstractDeviceComponentState
-
- org.somda.sdc.biceps.model.participant.BatteryState
-
- All Implemented Interfaces:
Cloneable,org.jvnet.jaxb2_commons.lang.CopyTo2,org.jvnet.jaxb2_commons.lang.ToString2
public class BatteryState extends AbstractDeviceComponentState implements Cloneable, org.jvnet.jaxb2_commons.lang.CopyTo2, org.jvnet.jaxb2_commons.lang.ToString2
State of a battery of an MDS. The current power source is designated by ./@ActivationState: - If ./@ActivationState equals "On", the device is running on battery - If ./@ActivationState equals "Off", the device is in mains operation and currently not able to be run on battery - If ./@ActivationState equals "StndBy", the device is in mains operation and can be switched to run on battery - If ./@ActivationState equals "Fail", the battery has a malfunction. Detailed error information SHOULD be communicated by using an ALERT SYSTEM. Enumerations "Shtdn" and "NotRdy" are undefined for BatteryState.Java class for BatteryState complex type.
The following schema fragment specifies the expected content contained within this class.
<complexType name="BatteryState"> <complexContent> <extension base="{http://standards.ieee.org/downloads/11073/11073-10207-2017/participant}AbstractDeviceComponentState"> <sequence> <element name="CapacityRemaining" type="{http://standards.ieee.org/downloads/11073/11073-10207-2017/participant}Measurement" minOccurs="0"/> <element name="Voltage" type="{http://standards.ieee.org/downloads/11073/11073-10207-2017/participant}Measurement" minOccurs="0"/> <element name="Current" type="{http://standards.ieee.org/downloads/11073/11073-10207-2017/participant}Measurement" minOccurs="0"/> <element name="Temperature" type="{http://standards.ieee.org/downloads/11073/11073-10207-2017/participant}Measurement" minOccurs="0"/> <element name="RemainingBatteryTime" type="{http://standards.ieee.org/downloads/11073/11073-10207-2017/participant}Measurement" minOccurs="0"/> </sequence> <attribute name="ChargeStatus"> <simpleType> <restriction base="{http://www.w3.org/2001/XMLSchema}string"> <enumeration value="Ful"/> <enumeration value="ChB"/> <enumeration value="DisChB"/> <enumeration value="DEB"/> </restriction> </simpleType> </attribute> <attribute name="ChargeCycles" type="{http://www.w3.org/2001/XMLSchema}unsignedInt" /> </extension> </complexContent> </complexType>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classBatteryState.ChargeStatusJava class for null.
-
Field Summary
Fields Modifier and Type Field Description protected MeasurementcapacityRemainingprotected LongchargeCyclesprotected BatteryState.ChargeStatuschargeStatusprotected Measurementcurrentprotected MeasurementremainingBatteryTimeprotected Measurementtemperatureprotected Measurementvoltage-
Fields inherited from class org.somda.sdc.biceps.model.participant.AbstractDeviceComponentState
activationState, calibrationInfo, nextCalibration, operatingCycles, operatingHours, physicalConnector
-
Fields inherited from class org.somda.sdc.biceps.model.participant.AbstractState
descriptorHandle, descriptorVersion, extension, stateVersion
-
-
Constructor Summary
Constructors Constructor Description BatteryState()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description StringBuilderappend(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)StringBuilderappendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)Objectclone()ObjectcopyTo(Object target)ObjectcopyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, Object target, org.jvnet.jaxb2_commons.lang.CopyStrategy2 strategy)ObjectcreateNewInstance()booleanequals(Object object)MeasurementgetCapacityRemaining()Gets the value of the capacityRemaining property.LonggetChargeCycles()Gets the value of the chargeCycles property.BatteryState.ChargeStatusgetChargeStatus()Gets the value of the chargeStatus property.MeasurementgetCurrent()Gets the value of the current property.MeasurementgetRemainingBatteryTime()Gets the value of the remainingBatteryTime property.MeasurementgetTemperature()Gets the value of the temperature property.MeasurementgetVoltage()Gets the value of the voltage property.inthashCode()voidsetCapacityRemaining(Measurement value)Sets the value of the capacityRemaining property.voidsetChargeCycles(Long value)Sets the value of the chargeCycles property.voidsetChargeStatus(BatteryState.ChargeStatus value)Sets the value of the chargeStatus property.voidsetCurrent(Measurement value)Sets the value of the current property.voidsetRemainingBatteryTime(Measurement value)Sets the value of the remainingBatteryTime property.voidsetTemperature(Measurement value)Sets the value of the temperature property.voidsetVoltage(Measurement value)Sets the value of the voltage property.StringtoString()-
Methods inherited from class org.somda.sdc.biceps.model.participant.AbstractDeviceComponentState
getActivationState, getCalibrationInfo, getNextCalibration, getOperatingCycles, getOperatingHours, getPhysicalConnector, setActivationState, setCalibrationInfo, setNextCalibration, setOperatingCycles, setOperatingHours, setPhysicalConnector
-
Methods inherited from class org.somda.sdc.biceps.model.participant.AbstractState
getDescriptorHandle, getDescriptorVersion, getExtension, getStateVersion, setDescriptorHandle, setDescriptorVersion, setExtension, setStateVersion
-
-
-
-
Field Detail
-
capacityRemaining
protected Measurement capacityRemaining
-
voltage
protected Measurement voltage
-
current
protected Measurement current
-
temperature
protected Measurement temperature
-
remainingBatteryTime
protected Measurement remainingBatteryTime
-
chargeStatus
protected BatteryState.ChargeStatus chargeStatus
-
chargeCycles
protected Long chargeCycles
-
-
Method Detail
-
getCapacityRemaining
public Measurement getCapacityRemaining()
Gets the value of the capacityRemaining property.- Returns:
- possible object is
Measurement
-
setCapacityRemaining
public void setCapacityRemaining(Measurement value)
Sets the value of the capacityRemaining property.- Parameters:
value- allowed object isMeasurement
-
getVoltage
public Measurement getVoltage()
Gets the value of the voltage property.- Returns:
- possible object is
Measurement
-
setVoltage
public void setVoltage(Measurement value)
Sets the value of the voltage property.- Parameters:
value- allowed object isMeasurement
-
getCurrent
public Measurement getCurrent()
Gets the value of the current property.- Returns:
- possible object is
Measurement
-
setCurrent
public void setCurrent(Measurement value)
Sets the value of the current property.- Parameters:
value- allowed object isMeasurement
-
getTemperature
public Measurement getTemperature()
Gets the value of the temperature property.- Returns:
- possible object is
Measurement
-
setTemperature
public void setTemperature(Measurement value)
Sets the value of the temperature property.- Parameters:
value- allowed object isMeasurement
-
getRemainingBatteryTime
public Measurement getRemainingBatteryTime()
Gets the value of the remainingBatteryTime property.- Returns:
- possible object is
Measurement
-
setRemainingBatteryTime
public void setRemainingBatteryTime(Measurement value)
Sets the value of the remainingBatteryTime property.- Parameters:
value- allowed object isMeasurement
-
getChargeStatus
public BatteryState.ChargeStatus getChargeStatus()
Gets the value of the chargeStatus property.- Returns:
- possible object is
BatteryState.ChargeStatus
-
setChargeStatus
public void setChargeStatus(BatteryState.ChargeStatus value)
Sets the value of the chargeStatus property.- Parameters:
value- allowed object isBatteryState.ChargeStatus
-
getChargeCycles
public Long getChargeCycles()
Gets the value of the chargeCycles property.- Returns:
- possible object is
Long
-
setChargeCycles
public void setChargeCycles(Long value)
Sets the value of the chargeCycles property.- Parameters:
value- allowed object isLong
-
clone
public Object clone()
- Overrides:
clonein classAbstractDeviceComponentState
-
copyTo
public Object copyTo(Object target)
- Specified by:
copyToin interfaceorg.jvnet.jaxb2_commons.lang.CopyTo2- Overrides:
copyToin classAbstractDeviceComponentState
-
copyTo
public Object copyTo(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, Object target, org.jvnet.jaxb2_commons.lang.CopyStrategy2 strategy)
- Specified by:
copyToin interfaceorg.jvnet.jaxb2_commons.lang.CopyTo2- Overrides:
copyToin classAbstractDeviceComponentState
-
createNewInstance
public Object createNewInstance()
- Specified by:
createNewInstancein interfaceorg.jvnet.jaxb2_commons.lang.CopyTo2- Overrides:
createNewInstancein classAbstractDeviceComponentState
-
equals
public boolean equals(Object object)
- Overrides:
equalsin classAbstractDeviceComponentState
-
hashCode
public int hashCode()
- Overrides:
hashCodein classAbstractDeviceComponentState
-
toString
public String toString()
- Overrides:
toStringin classAbstractDeviceComponentState
-
append
public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
- Specified by:
appendin interfaceorg.jvnet.jaxb2_commons.lang.ToString2- Overrides:
appendin classAbstractDeviceComponentState
-
appendFields
public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
- Specified by:
appendFieldsin interfaceorg.jvnet.jaxb2_commons.lang.ToString2- Overrides:
appendFieldsin classAbstractDeviceComponentState
-
-