Namespace clearpath

Detailed Description

/ _

/ _/ / / _/ / _/ _ ___ _ ___ ___ ____ ____ ___ _____ _ _ / _/ / / _| | | __| / _ | ++ | ++ / _ |_ _|| | | | _/ _/ / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | _/ / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | _____/ ___/|___||___||_| |_||_| _|_| |_| |_| |_| |_| |_| ROBOTICS™

File: Exception.h Desc: Provides the Class Exception class, which is the parent class for all clearpath exceptions. Auth: Iain Peet

Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please send comments, questions, or patches to skynet@clearpathrobotics.com

/ _

/ _/ / / _/ / _/ _ ___ _ ___ ___ ____ ____ ___ _____ _ _ / _/ / / _| | | __| / _ | ++ | ++ / _ |_ _|| | | | _/ _/ / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | _/ / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | _____/ ___/|___||___||_| |_||_| _|_| |_| |_| |_| |_| |_| ROBOTICS™

File: Logger.h Desc: Provides the Class Logger singleton which is used within the Clearpath API for log / trace message control Auth: Iain Peet

Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please send comments, questions, or patches to skynet@clearpathrobotics.com

/ _

/ _/ / / _/ / _/ _ ___ _ ___ ___ ____ ____ ___ _____ _ _ / _/ / / _| | | __| / _ | ++ | ++ / _ |_ _|| | | | _/ _/ / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | _/ / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | _____/ ___/|___||___||_| |_||_| _|_| |_| |_| |_| |_| |_| ROBOTICS�

File: Message.h Desc: Definition for the Class Message class. This class represents a single message which is sent or received from a platform Auth: R. Gariepy, Iain Peet

Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please send comments, questions, or patches to skynet@clearpathrobotics.com

/ _

/ _/ / / _/ / _/ _ ___ _ ___ ___ ____ ____ ___ _____ _ _ / _/ / / _| | | __| / _ | ++ | ++ / _ |_ _|| | | | _/ _/ / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | _/ / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | _____/ ___/|___||___||_| |_||_| _|_| |_| |_| |_| |_| |_| ROBOTICS™

File: Message_cmd.h Desc: Provides Set Class Message subclasses. Auth: Iain Peet

Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please send comments, questions, or patches to skynet@clearpathrobotics.com

/ _

/ _/ / / _/ / _/ _ ___ _ ___ ___ ____ ____ ___ _____ _ _ / _/ / / _| | | __| / _ | ++ | ++ / _ |_ _|| | | | _/ _/ / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | _/ / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | _____/ ___/|___||___||_| |_||_| _|_| |_| |_| |_| |_| |_| ROBOTICS™

File: HorizonMessage_data.h Desc: Provides Class Message subclasses corresponding to ‘data’ type messages Auth: Iain Peet, Mike Purvis

Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please send comments, questions, or patches to skynet@clearpathrobotics.com

/ _

/ _/ / / _/ / _/ _ ___ _ ___ ___ ____ ____ ___ _____ _ _ / _/ / / _| | | __| / _ | ++ | ++ / _ |_ _|| | | | _/ _/ / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | _/ / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | _____/ ___/|___||___||_| |_||_| _|_| |_| |_| |_| |_| |_| ROBOTICS™

File: Message_request.h Desc: Provides the Class Request class, which is used to request data messages at a particular frequency. Auth: Iain Peet

Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please send comments, questions, or patches to skynet@clearpathrobotics.com

/ _

/ _/ / / _/ / _/ _ ___ _ ___ ___ ____ ____ ___ _____ _ _ / _/ / / _| | | __| / _ | ++ | ++ / _ |_ _|| | | | _/ _/ / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | _/ / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | _____/ ___/|___||___||_| |_||_| _|_| |_| |_| |_| |_| |_| ROBOTICS™

File: Number.h Desc: Provides a family of functions similar in form to stdlib atoi and friends, for conversion between numeric primitives and small-endian byte arrays. Auth: Iain Peet

Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please send comments, questions, or patches to skynet@clearpathrobotics.com

/ _

/ _/ / / _/ / _/ _ ___ _ ___ ___ ____ ____ ___ _____ _ _ / _/ / / _| | | __| / _ | ++ | ++ / _ |_ _|| | | | _/ _/ / | | | | | ++ | |_| || ++ / | ++_/| |_| | | | | +-+ | _/ / | |_ | |_ | ++ | _ || |\ \ | | | _ | | | | +-+ | _____/ ___/|___||___||_| |_||_| _|_| |_| |_| |_| |_| |_| ROBOTICS�

File: Transport.h Desc: Definition for Horizon transport class. Implements the details of the Horizon communication medium, providing the ability to send and receive messages. Received messages are queued. Auth: R. Gariepy

Copyright (c) 2010, Clearpath Robotics, Inc. All Rights Reserved

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

• Neither the name of Clearpath Robotics, Inc. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CLEARPATH ROBOTICS, INC. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Please send comments, questions, or patches to skynet@clearpathrobotics.com

Classes

• Class BadAckException

• Class CmdMessage

• Class CmdProcessorReset

• Class CmdRestoreSettings

• Class CmdStoreSettings

• Class DataAckermannOutput

• Class DataDifferentialControl

• Class DataDifferentialOutput

• Class DataDifferentialSpeed

• Class DataEcho

• Class DataEncoders

• Class DataEncodersRaw

• Class DataFirmwareInfo

• Class DataFirmwareInfo::WriteTime

• Class DataGear

• Class DataMaxAcceleration

• Class DataMaxSpeed

• Class DataPlatformAcceleration

• Class DataPlatformInfo

• Class DataPlatformMagnetometer

• Class DataPlatformName

• Class DataPlatformOrientation

• Class DataPlatformRotation

• Class DataPowerSystem

• Class DataPowerSystem::BatteryDescription

• Class DataProcessorStatus

• Class DataRangefinders

• Class DataRangefinderTimings

• Class DataRawAcceleration

• Class DataRawCurrent

• Class DataRawGyro

• Class DataRawMagnetometer

• Class DataRawOrientation

• Class DataRawTemperature

• Class DataRawVoltage

• Class DataSafetySystemStatus

• Class DataSystemStatus

• Class DataVelocity

• Class Exception

• Class Logger

• Class Message

• Class MessageException

• Class Request

• Class SetAckermannOutput

• Class SetDifferentialControl

• Class SetDifferentialOutput

• Class SetDifferentialSpeed

• Class SetGear

• Class SetMaxAccel

• Class SetMaxSpeed

• Class SetPlatformName

• Class SetPlatformTime

• Class SetSafetySystem

• Class SetTurn

• Class SetVelocity

• Class Transport

• Class TransportException

Enums

• Enum MessageTypes

Functions

• Function clearpath::btof

• Function clearpath::btoi

• Function clearpath::btou

• Function clearpath::ftob

• Function clearpath::itob(void *, size_t, int64_t)

• Function clearpath::itob(void *, size_t, int32_t)

• Function clearpath::itob(void *, size_t, int16_t)

• Function clearpath::loggerTermHandler

• Function clearpath::utob(void *, size_t, uint64_t)

• Function clearpath::utob(void *, size_t, uint32_t)

• Function clearpath::utob(void *, size_t, uint16_t)