CommInterface.h

00001 #ifndef COMMINTERFACE_H
00002 #define COMMINTERFACE_H
00003 
00004 /** This pure virtual class for communications link of interface. This class
00005 * should be derived from when creating a class to manage the underlying connection
00006 * of a new link type.
00007 */
00008 class CommInterface
00009 {
00010 public:
00011     /** This method is used to establish a connection on a communications link. Required
00012     * configurations and settings should be done in other calls or an init function.
00013     *
00014     * @returns true if the connection was successfully established, otherwise false.
00015     */
00016     virtual bool connect() = 0;
00017 
00018     /** This method is used to disconnect a communications like. This includes
00019     * any cleanup required before another connection can be made.
00020     */
00021     virtual void disconnect() = 0;
00022 
00023     /** This method is used to check if the link is currently connected.
00024     *
00025     * @returns true if currently connected, otherwise false.
00026     */
00027     virtual bool isConnected() = 0;
00028     
00029     /** This method is used to reset the device that provides the communications
00030     * capability. Note that this call should block until the commincations device
00031     * is ready for use.
00032     */
00033     virtual void reset() = 0;
00034 };
00035 
00036 #endif /* COMMINTERFACE_H */