HamsterAPIJava - Revision history

Cogniteam at 13:54, 28 February 2017

2017-02-28T13:54:51Z

Cogniteam at 13:52, 28 February 2017

2017-02-28T13:52:16Z

Cogniteam at 13:49, 28 February 2017

2017-02-28T13:49:18Z

Show changes

Cogniteam at 13:41, 28 February 2017

2017-02-28T13:41:51Z

Cogniteam at 13:38, 28 February 2017

2017-02-28T13:38:13Z

Show changes

Cogniteam at 13:32, 28 February 2017

2017-02-28T13:32:45Z

Cogniteam at 13:30, 28 February 2017

2017-02-28T13:30:36Z

Cogniteam at 13:11, 28 February 2017

2017-02-28T13:11:02Z

Cogniteam at 13:09, 28 February 2017

2017-02-28T13:09:28Z

Cogniteam at 13:02, 28 February 2017

2017-02-28T13:02:48Z

@@ Line 457: / Line 457: @@
+==  public void cleanBuffers() ==
 {| class="wikitable"
 |-
@@ Line 472: / Line 472: @@
 {| class="wikitable"
 |-
@@ Line 496: / Line 497: @@
 {| class="wikitable"
 |-
@@ Line 521: / Line 523: @@
 {| class="wikitable"
 |-
@@ Line 550: / Line 553: @@
 {| class="wikitable"
 |-
@@ Line 571: / Line 575: @@
 {| class="wikitable"
 |-
@@ Line 594: / Line 599: @@
 {| class="wikitable"
 |-
@@ Line 618: / Line 624: @@
+== public void setDataMessageBufferSize(Integer size) ==
 {| class="wikitable"
 |-
@@ Line 644: / Line 649: @@
 {| class="wikitable"
 |-
@@ Line 668: / Line 674: @@
 {| class="wikitable"
 |-
@@ Line 683: / Line 690: @@
 {| class="wikitable"
 |-

@@ Line 620: / Line 620: @@
-Method Name
+{| class="wikitable"
+|-
 public void setDataMessageBufferSize(Integer size)
+|-
+|Method Description ||
 Setter for the size of the data message buffer.
 The following API can be used for messages:
-- hasDataMessages().
+* hasDataMessages().
-- getLatestDataMessage().
+* getLatestDataMessage().
-- getLatestDataMessages(Amount).
+* getLatestDataMessages(Amount).
-- getDataMessagesAmount().
+* getDataMessagesAmount().
-- clearDataMessagesBuffer().
+* clearDataMessagesBuffer().
-- setDataMessageBufferSize(Amount).
+* setDataMessageBufferSize(Amount).
-- getDataMessageBufferSize().
+* getDataMessageBufferSize().
-- sendDataMessage(Agent, DataMessage). - sendBroadcastDataMessage(DataMessage)
+* sendDataMessage(Agent, DataMessage).
+* sendBroadcastDataMessage(DataMessage)
-Return values
+{| class="wikitable"
+|-
-Possible Errors (HamsterError)
+!Method Name !!
 public Integer getDataMessageBufferSize()
-Method Description
+|-
 Getter for the size of the data message buffer.The following API can be used for
 messages:
-- hasDataMessages().
+* hasDataMessages().
-- getLatestDataMessage().
+* getLatestDataMessage().
-- getLatestDataMessages(Amount).
+* getLatestDataMessages(Amount).
-- getDataMessagesAmount().
+* getDataMessagesAmount().
-- clearDataMessagesBuffer().
+* clearDataMessagesBuffer().
-- setDataMessageBufferSize(Amount).
+* setDataMessageBufferSize(Amount).
-- getDataMessageBufferSize().
+* getDataMessageBufferSize().
-- sendDataMessage(Agent, DataMessage). - sendBroadcastDataMessage(DataMessage)
+* sendDataMessage(Agent, DataMessage).
+* sendBroadcastDataMessage(DataMessage)
+|-
-Return values	 Integer
+|Return values	|| Integer
-Possible Errors (HamsterError)
+|-
+|Possible Errors (HamsterError) ||
+|}
-Method Name
+{| class="wikitable"
 public void reconnect() throws HamsterError
+|-
-Method Description
+|Method Description ||
 Tries to reconnect to the server.
+{| class="wikitable"
+|-
-Method Name
+!Method Name !!
 public void disconnect()
+|-
-Method Description	Disconnects from the server.
+|Method Description || Disconnects from the server.
-Return values
+|-
-Possible Errors (HamsterError)
+|Return values ||

@@ Line 288: / Line 288: @@
+== public void sendSpeed(float velocity, float wheels_angle) throws HamsterError ==
 {| class="wikitable"
 |-
@@ Line 305: / Line 305: @@
 * Running Goal.
 |}
 {| class="wikitable"
 |-
@@ Line 325: / Line 324: @@
+== public void switchMode(HamsterMode mode) throws HamsterError ==
 {| class="wikitable"
 |-
@@ Line 343: / Line 342: @@
 {| class="wikitable"
 |-
@@ Line 359: / Line 359: @@
 {| class="wikitable"
 |-
@@ Line 374: / Line 375: @@
 {| class="wikitable"
 |-
@@ Line 390: / Line 392: @@
 {| class="wikitable"
 |-
@@ Line 406: / Line 409: @@
-Method Name
+{| class="wikitable"
 public Integer getAgentID()
-Method Description
+|-
 Getter for the current Agent ID.
+|-
-Return values
+|Return values ||
 AgentID (Integer)
+{| class="wikitable"
-Method Name
+|-
 public float getLidarResolution()
-Method Description
+|-
 Getter for the lidar resolution.
+|-
-Return values
+|Return values ||
 float
+{| class="wikitable"
-Method Name
+|-
 public boolean isConnected()
+|-
-Method Description
+|Method Description ||
 Checks whether the client is still connected to the server.
 A connection problem can arise from heartbeat failure or from FIN from the server side.
+|-
-Return values
+|Return values ||
 boolean
+|-
-Possible Errors (HamsterError)
+|Possible Errors (HamsterError) ||

@@ Line 226: / Line 226: @@
 * Connection Issue.
 |}
 {| class="wikitable"
 |-
@@ Line 249: / Line 248: @@
-Method Name
+{| class="wikitable"
 public NetworkState getNetworkState() throws HamsterError
+|-
-Method Description
+| Method Description ||
 Retrieves the current network state of the hamster with the network.
 Buffer Size - 1.
+|-
-Return values
+| Return values ||
 NetworkState
+{| class="wikitable"
+|-
+!Method Name!!
 public NavigationState getNavigationState() throws HamsterError
+|-
-Method Description
+|Method Description ||
 Retrieves the navigation state of the hamster. The navigation state depends whether there was a goal request or not. There are four types of states:
-- Offline.
+* Offline.
-- In Progress.
+* In Progress.
-- Reached Goal.
+* Reached Goal.
-- Failure.
+* Failure.
-Buffer Size - 1.
+* Buffer Size - 1.
+|-
-Return values
+|Return values ||
 NavigationState
+|-
-Possible Errors (HamsterError)
+| Possible Errors (HamsterError)||
-- Empty Buffer.
+* Empty Buffer.
-- Connection Issue.
+* Connection Issue.
+|}

@@ Line 187: / Line 187: @@
+== public OccupancyGrid getSLAMMap() throws HamsterError ==
-Method Name
+{| class="wikitable"
 public OccupancyGrid getSLAMMap() throws HamsterError
+|-
-Method Description
+| Method Description ||
 Retrieves the current SLAM map that was loaded or created by the hamster as an occupancy grid.
 Buffer Size - 1.
+|-
-Return values
+| Return values	||
 OccupancyGrid
+== public HamsterConnections getConnectedHamsters() throws HamsterError ==
+{| class="wikitable"
+|-
-Method Name
+!Method Name !!
 public HamsterConnections getConnectedHamsters() throws HamsterError
+|-
-Method Description
+| Method Description ||
 Retrieves the currently living hamsters on the network.
 Meaning that for example there are 3 hamsters on the same network
@@ Line 214: / Line 218: @@
 If the current hamster got a heartbeat from all the others, there will be 3 connections on the list.
 Buffer Size - 1.
+|-
-Return values
+| Return values	||
 HamsterConnections
+|-
-Possible Errors (HamsterError)
+| Possible Errors (HamsterError)||
--Empty Buffer.
+* Empty Buffer.
--Connection Issue.
+* Connection Issue.
+|}
-Method Name
+{| class="wikitable"
 public BatteryState getBatteryState() throws HamsterError
+|-
-Method Description
+| Method Description ||
 Retrieves the current battery state of the hamster.
 Buffer Size - 1.
+|-
-Return values
+|Return values ||
 BatteryState
+|-
-Possible Errors (HamsterError)
+| Possible Errors (HamsterError) ||
--Empty Buffer.
+* Empty Buffer.
--Connection Issue.
+* Connection Issue.
+|}

@@ Line 29: / Line 29: @@
 |}
+== public Image getCameraImage() throws HamsterError ==
 {| class="wikitable"
 |-
@@ Line 48: / Line 48: @@
 {| class="wikitable"
 |-
@@ Line 67: / Line 68: @@
 {| class="wikitable"
 |-
@@ Line 85: / Line 87: @@
 {| class="wikitable"
 |-
@@ Line 103: / Line 106: @@
 {| class="wikitable"
 |-
@@ Line 121: / Line 125: @@
 {| class="wikitable"
 |-
@@ Line 139: / Line 144: @@
 |}
+== public Speed getSpeed() throws HamsterError ==
 {| class="wikitable"
 |-
@@ Line 159: / Line 164: @@
 {| class="wikitable"
 |-