cmtscan.h

Go to the documentation of this file.
00001 #ifndef _CMT_MONOLITHIC
00002 /*! \file
00003         \brief        Contains the ScanPorts interface
00004 
00005         This file contains the interfaces for the functions that are required for scanning ports
00006         for Xsens devices.
00007 
00008         \section FileCopyright Copyright Notice 
00009         Copyright (C) Xsens Technologies B.V., 2006.  All rights reserved.
00010 
00011         This source code is intended for use only by Xsens Technologies BV and
00012         those that have explicit written permission to use it from
00013         Xsens Technologies BV.
00014 
00015         THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
00016         KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
00017         IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A
00018         PARTICULAR PURPOSE.
00019 
00020         \section FileChangelog        Changelog
00021         \par 2006-06-09, v0.0.1
00022         \li Job Mulder:        Created ScanPorts.h
00023         \par 2006-07-21, v0.1.0
00024         \li Job Mulder:        Updated file for release 0.1.0
00025 */
00026 #endif
00027 
00028 #ifndef _SCANPORTS_H_2006_06_09
00029 #define _SCANPORTS_H_2006_06_09
00030 
00031 #ifndef _CMT_MONOLITHIC
00032 #        include "xsens_list.h"
00033 #endif
00034 
00035 namespace xsens {
00036 
00037 bool cmtScanForIMU(CmtPortInfo & port, uint32_t baudrate = 0, uint32_t singleScanTimeout = 1000, uint32_t scanTries = 1);
00038 
00039 /*! \brief Scan COM ports for connected Xsens devices.
00040 
00041         The cmtScanPorts function will scan registered Xsens USB converters and serial COM ports
00042         for connected Xsens devices. If the baudrate parameter is 0 (default), it will try to
00043         connect at all supported baud rates, starting with the most common 115k2, 460k8 and 
00044         58k6. If the baudrate parameter is non-zero, only the specified baudrate is tried.
00045         Any detected devices are returned in the ports list, which is sorted by port nr.
00046         
00047 */
00048 bool cmtScanPorts(List<CmtPortInfo>& ports, uint32_t baudrate = 0, uint32_t singleScanTimeout = 1000, uint32_t scanTries = 1);
00049 
00050 /*! \brief Scan a single COM port for connected Xsens devices.
00051 
00052         The cmtScanPort function will scan a single port for connected Xsens devices. If the
00053         baudrate parameter is 0 (default), it will try to connect at all supported baud 
00054         rates, starting with the most common 115k2, 460k8 and 58k6. If the baudrate parameter
00055         is non-zero, only the specified baud rate is tried. Any detected devices are returned
00056         in the portInfo parameter.
00057         
00058 */
00059 bool cmtScanPort(CmtPortInfo& portInfo, uint32_t baudrate = 0, uint32_t singleScanTimeout = 1000, uint32_t scanTries = 1);
00060 
00061 //! Set to true from another thread to abort any scan currently in progress.
00062 extern bool abortScan;
00063 
00064 } // end of xsens namespace
00065 
00066 #endif        // _SCANPORTS_H_2006_06_09
Generated on Sun May 8 08:05:57 2011 for iLab Neuromorphic Vision Toolkit by  doxygen 1.6.3