Commit e35637dd authored by Julian Zobel's avatar Julian Zobel
Browse files

-- Renamed the Attraction Point Interface from AttractionPoint to IAttractionPoint

parent 73d429c9
...@@ -26,7 +26,7 @@ package de.tudarmstadt.maki.simonstrator.api.component.sensor.location; ...@@ -26,7 +26,7 @@ package de.tudarmstadt.maki.simonstrator.api.component.sensor.location;
* @author Bjoern Richerzhagen * @author Bjoern Richerzhagen
* *
*/ */
public interface AttractionPoint extends Location { public interface IAttractionPoint extends Location {
/** /**
* Name of the attraction point * Name of the attraction point
...@@ -43,12 +43,12 @@ public interface AttractionPoint extends Location { ...@@ -43,12 +43,12 @@ public interface AttractionPoint extends Location {
* @param newName * @param newName
* @return * @return
*/ */
public AttractionPoint clone(String newName); public IAttractionPoint clone(String newName);
/** /**
* A weight (should be normalized between 0 and 1), can be used for example * A weight (should be normalized between 0 and 1), can be used for example
* in the social movement model. This refers to the "importance" of an * in the social movement model. This refers to the "importance" of an
* {@link AttractionPoint}. * {@link IAttractionPoint}.
* *
* @return weight between 0 and 1 * @return weight between 0 and 1
*/ */
...@@ -69,7 +69,7 @@ public interface AttractionPoint extends Location { ...@@ -69,7 +69,7 @@ public interface AttractionPoint extends Location {
/** /**
* A weight (should be normalized between 0 and 1), can be used for example * A weight (should be normalized between 0 and 1), can be used for example
* in the social movement model. This refers to the "importance" of an * in the social movement model. This refers to the "importance" of an
* {@link AttractionPoint}. * {@link IAttractionPoint}.
* *
* @param weight * @param weight
*/ */
......
...@@ -49,9 +49,9 @@ public interface LocationActuator extends LocationSensor { ...@@ -49,9 +49,9 @@ public interface LocationActuator extends LocationSensor {
* {@link UnsupportedOperationException} if it is not supported. * {@link UnsupportedOperationException} if it is not supported.
* *
* @param targetAttractionPoint * @param targetAttractionPoint
* {@link AttractionPoint} the node should move to. * {@link IAttractionPoint} the node should move to.
*/ */
public void setTargetAttractionPoint(AttractionPoint targetAttractionPoint) throws UnsupportedOperationException; public void setTargetAttractionPoint(IAttractionPoint targetAttractionPoint) throws UnsupportedOperationException;
/** /**
* Returns all currently known (to this node) attraction points. These can * Returns all currently known (to this node) attraction points. These can
...@@ -59,14 +59,14 @@ public interface LocationActuator extends LocationSensor { ...@@ -59,14 +59,14 @@ public interface LocationActuator extends LocationSensor {
* *
* @return * @return
*/ */
public Set<AttractionPoint> getAllAttractionPoints(); public Set<IAttractionPoint> getAllAttractionPoints();
/** /**
* Programmatically add a new attraction point. Currently not supported. * Programmatically add a new attraction point. Currently not supported.
* *
* @param attractionPoint * @param attractionPoint
*/ */
default public void addAttractionPoint(AttractionPoint attractionPoint) { default public void addAttractionPoint(IAttractionPoint attractionPoint) {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
} }
...@@ -75,7 +75,7 @@ public interface LocationActuator extends LocationSensor { ...@@ -75,7 +75,7 @@ public interface LocationActuator extends LocationSensor {
* *
* @param toRemove * @param toRemove
*/ */
default public void removeAttractionPoint(AttractionPoint toRemove) { default public void removeAttractionPoint(IAttractionPoint toRemove) {
throw new UnsupportedOperationException(); throw new UnsupportedOperationException();
} }
......
...@@ -78,11 +78,11 @@ public interface LocationSensor extends SensorComponent { ...@@ -78,11 +78,11 @@ public interface LocationSensor extends SensorComponent {
public LocationRequest getLocationRequest(); public LocationRequest getLocationRequest();
/** /**
* Retrieve the targeted {@link AttractionPoint}, representing the location * Retrieve the targeted {@link IAttractionPoint}, representing the location
* the node is currently approaching. * the node is currently approaching.
* *
* @return * @return
*/ */
public AttractionPoint getCurrentTargetAttractionPoint(); public IAttractionPoint getCurrentTargetAttractionPoint();
} }
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment