HamsterAPICPP - Revision history

Cogniteam at 10:33, 28 February 2017

2017-02-28T10:33:23Z

Cogniteam at 10:28, 28 February 2017

2017-02-28T10:28:49Z

Cogniteam at 10:26, 28 February 2017

2017-02-28T10:26:22Z

Cogniteam at 10:24, 28 February 2017

2017-02-28T10:24:58Z

Cogniteam at 10:24, 28 February 2017

2017-02-28T10:24:02Z

Cogniteam at 10:21, 28 February 2017

2017-02-28T10:21:28Z

Cogniteam at 10:20, 28 February 2017

2017-02-28T10:20:32Z

Cogniteam at 10:18, 28 February 2017

2017-02-28T10:18:47Z

Cogniteam at 10:14, 28 February 2017

2017-02-28T10:14:27Z

Show changes

Cogniteam at 10:05, 28 February 2017

2017-02-28T10:05:08Z

Show changes

@@ Line 319: / Line 319: @@
+== void switchMode(const HamsterMode & mode) ==
 {| class="wikitable"
 |-
@@ Line 336: / Line 336: @@
 |}
+== void navigateTo(const Goal & goal) ==
 {| class="wikitable"
 |-
@@ Line 352: / Line 352: @@
+== void navigateTo(float distance, float angle) ==
 {| class="wikitable"
 |-
@@ Line 368: / Line 366: @@
 |}
+== void setInitialPose(const Pose & pose) ==
 {| class="wikitable"
 |-
@@ Line 385: / Line 383: @@
 {| class="wikitable"
 |-
@@ Line 398: / Line 397: @@
 {| class="wikitable"
 |-
@@ Line 409: / Line 409: @@
 |}
 {| class="wikitable"
 |-
@@ Line 423: / Line 425: @@
 {| class="wikitable"
 |-
@@ Line 438: / Line 441: @@
+== void cleanBuffers() ==
 {| class="wikitable"
 |-
@@ Line 451: / Line 454: @@
 |}
 {| class="wikitable"
 |-
@@ Line 476: / Line 481: @@
 {| class="wikitable"
 |-
@@ Line 501: / Line 507: @@
 {| class="wikitable"
 |-
 !Method Name		 !!
-* DataMessage getLatestDataMessage()const std::vector<DataMessage> getLatestDataMessages(uint32_t amount)const
+* DataMessage getLatestDataMessage() const std::vector<DataMessage> getLatestDataMessages(uint32_t amount)const
 * DataMessage popLatestDataMessage() std::vector<DataMessage> popLatestDataMessages(uint32_t amount)
 |-
@@ Line 529: / Line 536: @@
 {| class="wikitable"
 |-
@@ Line 552: / Line 560: @@
 |}
 {| class="wikitable"
 |-
@@ Line 575: / Line 585: @@
 |}
 {| class="wikitable"
 |-
@@ Line 597: / Line 609: @@
 |Possible Errors (HamsterError) ||
 |}
 {| class="wikitable"
 |-
@@ Line 625: / Line 636: @@
 {| class="wikitable"
 |-
@@ Line 650: / Line 662: @@
+== void reconnect() ==
 {| class="wikitable"
 |-
@@ Line 668: / Line 678: @@
 {| class="wikitable"
 |-
@@ Line 679: / Line 690: @@
 |Possible Errors (HamsterError)	||
 |}

@@ Line 77: / Line 77: @@
 |}
 {| class="wikitable"
 |-
@@ Line 92: / Line 93: @@
 |}
 {| class="wikitable"
 |-
@@ Line 108: / Line 110: @@
 |}
+== ColoredScan getColoredScan()const ==
 {| class="wikitable"
 |-
 !Method Name !!
 ColoredScan getColoredScan()const
 |-
 | Method Description ||
@@ Line 119: / Line 120: @@
 It contains the raw lidar scan and the associated pixels RGB color of the image.
 Buffer Size - 1
 |-
 | Return values		||
 ColoredScan
 |-
 | Possible Errors (HamsterError) ||
@@ Line 133: / Line 132: @@
+== Speed getSpeed()const ==
 {| class="wikitable"
 |-
@@ Line 152: / Line 151: @@
+== HamsterMode getHamsterMode()const ==
 {| class="wikitable"
 |-
@@ Line 176: / Line 175: @@
+== OccupancyGrid getSLAMMap()const ==
 {| class="wikitable"
 |-
@@ Line 195: / Line 194: @@
+== HamsterConnections getConnectedHamsters()const ==
 {| class="wikitable"
 |-
@@ Line 218: / Line 217: @@
+== BatteryState getBatteryState()const ==
 {| class="wikitable"
 |-
@@ Line 238: / Line 237: @@
+== NetworkState getNetworkState()const ==
 {| class="wikitable"
 |-
@@ Line 259: / Line 258: @@
+== NavigationState getNavigationState()const ==
 {| class="wikitable"
 |-
@@ Line 282: / Line 281: @@
+== void sendSpeed(float velocity, float wheels_angle)==
 {| class="wikitable"
 |-
@@ Line 302: / Line 301: @@
+== void sendOccupancyGrid(const OccupancyGrid & grid) ==
 {| class="wikitable"
 |-

@@ Line 1: / Line 1: @@
 [[Category:HamsterAPI]]
-HamsterAPI Class Documentation
+=== HamsterAPI Class Documentation ===
 Hamster class	File	Description
@@ Line 9: / Line 9: @@
 {| class="wikitable"
@@ Line 26: / Line 27: @@
 |}
+== Image getCameraImage() const ==
 {| class="wikitable"
 |-
@@ Line 42: / Line 43: @@
 |}
 {| class="wikitable"
 |-
@@ Line 59: / Line 61: @@
 |}
+== IMU getIMU()const ==
 {| class="wikitable"
 |-

@@ Line 593: / Line 593: @@
 |-
 |Return values	||
-Possible Errors (HamsterError) ||
+|-
 |}

@@ Line 452: / Line 452: @@
 {| class="wikitable"
 |-
-!Method Name		!!
+! Method Name		!!
 * void sendDataMessage(const AgentID & target_agent_id, const std::string & message)
 * void sendDataMessage(const DataMessage & message)
@@ Line 465: / Line 465: @@
 * setDataMessageBufferSize(Amount).
 * getDataMessageBufferSize().
-* sendDataMessage(Agent, DataMessage). -sendBroadcastDataMessage(DataMessage).
+* sendDataMessage(Agent, DataMessage).
 |-
 |Return values	||
@@ Line 534: / Line 535: @@
 |Method Description ||
 Checks whether there are any messages. 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).
 |-
 |Return values	||
@@ Line 556: / Line 558: @@
 |Method Description ||
 Getter for the amount of data messages. 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).
 |-
 |Return values ||
@@ Line 586: / Line 589: @@
 * setDataMessageBufferSize(Amount).
 * getDataMessageBufferSize().
-* sendDataMessage(Agent, DataMessage). - sendBroadcastDataMessage(DataMessage)
+* sendDataMessage(Agent, DataMessage).
 |-
 |Return values	||
@@ Line 610: / Line 614: @@
 * setDataMessageBufferSize(Amount).
 * getDataMessageBufferSize().
-* sendDataMessage(Agent, DataMessage). - sendBroadcastDataMessage(DataMessage)
+* sendDataMessage(Agent, DataMessage).
 |-
 |Return values ||
@@ Line 633: / Line 638: @@
 * setDataMessageBufferSize(Amount).
 * getDataMessageBufferSize().
-* sendDataMessage(Agent, DataMessage). - sendBroadcastDataMessage(DataMessage)
+* sendDataMessage(Agent, DataMessage).
 |-
 |Return values ||

@@ Line 12: / Line 12: @@
 {| class="wikitable"
 |-
-!Method Name !! Constructor: Hamster(const AgentID & agent_id, HamsterClientParameters params = HamsterClientParameters())!
+!Method Name !! Constructor: Hamster(const AgentID & agent_id, HamsterClientParameters params = HamsterClientParameters())
 |-
 | Method Description ||
@@ Line 338: / Line 338: @@
 {| class="wikitable"
 |-
-!Method Name	!! void navigateTo(const Goal & goal) ||
+!Method Name	!! void navigateTo(const Goal & goal)
 |-
 | Method Description ||

@@ Line 399: / Line 399: @@
 {| class="wikitable"
 |-
-!Method Name		 !!	 AgentID getAgentID()const
+!Method Name !!	 AgentID getAgentID()const
 |-
 | Method Description || Getter for the current Agent ID.
@@ Line 418: / Line 418: @@
 |Return values || float
 |-
-|Possible Errors || (HamsterError)
+|Possible Errors (HamsterError)	||
 |}
@@ Line 424: / Line 424: @@
 {| class="wikitable"
 |-
-!Method Name		 !!
+!Method Name !!	bool isConnected()const
 |-
 |Method Description ||
@@ Line 441: / Line 440: @@
 {| class="wikitable"
 |-
-!Method Name		 !!
+!Method Name !! void cleanBuffers()
 |-
 |Method Description ||
@@ Line 456: / Line 454: @@
 !Method Name		!!
 * void sendDataMessage(const AgentID & target_agent_id, const std::string & message)
-* void sendDataMessage(const DataMessage & message);
+* void sendDataMessage(const DataMessage & message)
 |-
-|Method Description
+|Method Description ||
 Sends a data message to another hamster. This will be published on the network with the current agent id and the target agent id. If the target is in the network, it will receive it. The following API can be used for messages:
 * hasDataMessages().
@@ Line 471: / Line 469: @@
 |Return values	||
 |-
-|Possible Errors || (HamsterError)
+|Possible Errors (HamsterError)	||
 * Connection Issue.
 |}