cz.cuni.amis.pogamut.multi.communication.worldview.property

Class AbstractSharedProperty<TYPE>

java.lang.Object

cz.cuni.amis.pogamut.multi.communication.worldview.property.AbstractSharedProperty<TYPE>

All Implemented Interfaces:

ISharedProperty<TYPE>, Cloneable

Direct Known Subclasses:

BooleanProperty, ColorProperty, Dimension2DProperty, DoubleProperty, FloatProperty, IntegerProperty, IntProperty, LocationProperty, LongProperty, RotationProperty, StringProperty, Vector3dProperty, VelocityProperty

public abstract class AbstractSharedProperty<TYPE>
extends Object
implements ISharedProperty<TYPE>

Abstract implementation of the ISharedProperty object, this class manages the methods every ISharedProperty needs to have, regardless of its type.

SharedProperties are generally derived from bot's subjective observation of the world (local properties). If the local properties, which are used to derive the value of the sharedProperty are dated, the sharedProperty is considered "dirty", because the value might be wrong, the team that owns this property only assumes the value.

Author:

srlok

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractSharedProperty.GenericPropertyUpdate

Field Summary

Fields

Modifier and Type	Field and Description
protected Class<?>	compositeClass
protected boolean	dirty
protected PropertyId	propertyId
protected TYPE	value

Constructor Summary

Constructors

Constructor and Description
AbstractSharedProperty(AbstractSharedProperty source) Used in copy-constructors, when writing a copy constructor for a descendant class, you must add a clone for value.
AbstractSharedProperty(WorldObjectId objectId, String identifier, Class compositeClass) Used in propertyConstructors from data.
AbstractSharedProperty(WorldObjectId objId, String identifier, TYPE value, Class<?> compositeClass)

Method Summary

Methods

Modifier and Type	Method and Description
abstract ISharedProperty<TYPE>	clone() Must return an exact duplicate of this ISharedProperty, this will be used to create old versions of SharedProperties in the worldView.
protected abstract TYPE	cloneValue() Every descendant must implement this by calling value.clone() or otherwise returning a new copy of value.
ISharedPropertyUpdatedEvent	createUpdateEvent(long time, ITeamId teamId) Creates an event updating a sharedProperty of the same id and the specified team to the same value as the parent property.
boolean	equals(Object another)
Class	getCompositeClass() Class of the compositeObject this property belongs to.
WorldObjectId	getObjectId() ObjectId of the object that this property is part of.
PropertyId	getPropertyId() Unique Id of this property.
TYPE	getValue() Returns value of the property.
int	hashCode()
boolean	isDirty() SharedProperties are generally properties derived from bot's observation of the world.
boolean	nullOverrides()
void	setDirty(boolean value)
void	setValue(TYPE value) Sets the value of the property - should be used by Pogamut Library developers only!

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface cz.cuni.amis.pogamut.multi.communication.worldview.object.ISharedProperty

getPropertyValueClass

Field Detail

propertyId

protected PropertyId propertyId

dirty

protected boolean dirty

compositeClass

protected Class<?> compositeClass

value

protected TYPE value

Constructor Detail

AbstractSharedProperty

public AbstractSharedProperty(WorldObjectId objId,
                      String identifier,
                      TYPE value,
                      Class<?> compositeClass)

AbstractSharedProperty

public AbstractSharedProperty(AbstractSharedProperty source)

Used in copy-constructors, when writing a copy constructor for a descendant class, you must add a clone for value.

Parameters:

source -

AbstractSharedProperty

public AbstractSharedProperty(WorldObjectId objectId,
                      String identifier,
                      Class compositeClass)

Used in propertyConstructors from data.

Parameters:

objectId -

identifier -

compositeClass -

Method Detail

nullOverrides

public boolean nullOverrides()

Specified by:

nullOverrides in interface ISharedProperty<TYPE>

cloneValue

protected abstract TYPE cloneValue()

Every descendant must implement this by calling value.clone() or otherwise returning a new copy of value.

Returns:

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object another)

Overrides:

equals in class Object

clone

public abstract ISharedProperty<TYPE> clone()

Description copied from interface: ISharedProperty

Must return an exact duplicate of this ISharedProperty, this will be used to create old versions of SharedProperties in the worldView.

Specified by:

clone in interface ISharedProperty<TYPE>

Overrides:

clone in class Object

Returns:

getValue

public TYPE getValue()

Description copied from interface: ISharedProperty

Returns value of the property.

Specified by:

getValue in interface ISharedProperty<TYPE>

Returns:

setValue

public void setValue(TYPE value)

Description copied from interface: ISharedProperty

Sets the value of the property - should be used by Pogamut Library developers only!

Specified by:

setValue in interface ISharedProperty<TYPE>

getCompositeClass

public Class getCompositeClass()

Description copied from interface: ISharedProperty

Class of the compositeObject this property belongs to.

Specified by:

getCompositeClass in interface ISharedProperty<TYPE>

Returns:

isDirty

public boolean isDirty()

Description copied from interface: ISharedProperty

SharedProperties are generally properties derived from bot's observation of the world. (like visible => spawned ). This may become a problem when the inferred information is outdated (ie. a bot can no longer see the spawned item, but the last time anybody from the team saw it, it was spawned). In this case, we consider the information "dirty", because the team only assumes the value. It can be wrong. (the game will always know the correct value of course, only our AI won't.

Specified by:

isDirty in interface ISharedProperty<TYPE>

Returns:

setDirty

public void setDirty(boolean value)

getObjectId

public WorldObjectId getObjectId()

Description copied from interface: ISharedProperty

ObjectId of the object that this property is part of.

Specified by:

getObjectId in interface ISharedProperty<TYPE>

Returns:

getPropertyId

public PropertyId getPropertyId()

Description copied from interface: ISharedProperty

Unique Id of this property.

Specified by:

getPropertyId in interface ISharedProperty<TYPE>

Returns:

createUpdateEvent

public ISharedPropertyUpdatedEvent createUpdateEvent(long time,
                                            ITeamId teamId)

Description copied from interface: ISharedProperty

Creates an event updating a sharedProperty of the same id and the specified team to the same value as the parent property.

Specified by:

createUpdateEvent in interface ISharedProperty<TYPE>

Returns: