Package xbot.common.properties

Class DistanceProperty

java.lang.Object

xbot.common.properties.Property

xbot.common.properties.DistanceProperty

All Implemented Interfaces:

DataFrameRefreshable

public class DistanceProperty
extends Property

This manages a Distance in the property system.

Nested Class Summary

Nested classes/interfaces inherited from class xbot.common.properties.Property

Property.PropertyLevel, Property.PropertyPersistenceType

Field Summary

Fields inherited from class xbot.common.properties.Property

activeStore, key, level, log, prefix, suffix

Constructor Summary

Constructors

Constructor	Description
DistanceProperty(String prefix, String name, Distance defaultValue, XPropertyManager manager)
DistanceProperty(String prefix, String name, Distance defaultValue, XPropertyManager manager, Property.PropertyLevel level)

Method Summary

Modifier and Type	Method	Description
Distance	get()
Distance	get_internal()
boolean	hasChangedSinceLastCheck()
void	hasChangedSinceLastCheck(Consumer<Distance> callback)
boolean	isSetToDefault()	Checks if the property's current value matches the default.
void	refreshDataFrame()	Consumes and processes inputs from the device or subsystem.
void	set(Distance value)

Methods inherited from class xbot.common.properties.Property

getLevel

Methods inherited from class java.lang.Object

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

Constructor Details

DistanceProperty

public DistanceProperty(String prefix,
 String name,
 Distance defaultValue,
 XPropertyManager manager)

DistanceProperty

public DistanceProperty(String prefix,
 String name,
 Distance defaultValue,
 XPropertyManager manager,
 Property.PropertyLevel level)

Method Details

get

public Distance get()

get_internal

public Distance get_internal()

set

public void set(Distance value)

hasChangedSinceLastCheck

public void hasChangedSinceLastCheck(Consumer<Distance> callback)

hasChangedSinceLastCheck

public boolean hasChangedSinceLastCheck()

isSetToDefault

public boolean isSetToDefault()

Description copied from class: Property

Checks if the property's current value matches the default.

Specified by:

isSetToDefault in class Property

Returns:

True if the current value is the default.

refreshDataFrame

public void refreshDataFrame()

Description copied from interface: DataFrameRefreshable

Consumes and processes inputs from the device or subsystem.