devices/deviceoptical/ordeviceoptical_hardware.h

#ifndef __ORDEVICE_OPTICAL_HARDWARE_H__
#define __ORDEVICE_OPTICAL_HARDWARE_H__
/***************************************************************************************
 Autodesk(R) Open Reality(R) Samples
 
 (C) 2009 Autodesk, Inc. and/or its licensors
 All rights reserved.
 
 AUTODESK SOFTWARE LICENSE AGREEMENT
 Autodesk, Inc. licenses this Software to you only upon the condition that 
 you accept all of the terms contained in the Software License Agreement ("Agreement") 
 that is embedded in or that is delivered with this Software. By selecting 
 the "I ACCEPT" button at the end of the Agreement or by copying, installing, 
 uploading, accessing or using all or any portion of the Software you agree 
 to enter into the Agreement. A contract is then formed between Autodesk and 
 either you personally, if you acquire the Software for yourself, or the company 
 or other legal entity for which you are acquiring the software.
 
 AUTODESK, INC., MAKES NO WARRANTY, EITHER EXPRESS OR IMPLIED, INCLUDING BUT 
 NOT LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR 
 PURPOSE REGARDING THESE MATERIALS, AND MAKES SUCH MATERIALS AVAILABLE SOLELY ON AN 
 "AS-IS" BASIS.
 
 IN NO EVENT SHALL AUTODESK, INC., BE LIABLE TO ANYONE FOR SPECIAL, COLLATERAL, 
 INCIDENTAL, OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH OR ARISING OUT OF PURCHASE 
 OR USE OF THESE MATERIALS. THE SOLE AND EXCLUSIVE LIABILITY TO AUTODESK, INC., 
 REGARDLESS OF THE FORM OF ACTION, SHALL NOT EXCEED THE PURCHASE PRICE OF THE 
 MATERIALS DESCRIBED HEREIN.
 
 Autodesk, Inc., reserves the right to revise and improve its products as it sees fit.
 
 Autodesk and Open Reality are registered trademarks or trademarks of Autodesk, Inc., 
 in the U.S.A. and/or other countries. All other brand names, product names, or 
 trademarks belong to their respective holders. 
 
 GOVERNMENT USE
 Use, duplication, or disclosure by the U.S. Government is subject to restrictions as 
 set forth in FAR 12.212 (Commercial Computer Software-Restricted Rights) and 
 DFAR 227.7202 (Rights in Technical Data and Computer Software), as applicable. 
 Manufacturer is Autodesk, Inc., 10 Duke Street, Montreal, Quebec, Canada, H3C 2L7.
***************************************************************************************/

//--- Maximum number of markers detected.
#define MAX_MARKER  100

//--- SDK include
#include <fbsdk/fbsdk.h>

#include "opticaldevicetester/DeviceBuffer.h"

class ORDeviceOptical_Template_Hardware
{
public:
    //--- Constructor & destructor
    ORDeviceOptical_Template_Hardware();        
    ~ORDeviceOptical_Template_Hardware();       

    //--- Client/server calls
    // Opens and closes connection with data server. returns true if successful
    bool        Open();                 
    bool        Close();                

    bool        GetSetupInfo();

    // Streaming functions
    // Once connection is established and information packets have been received
    // these functions start and stops the data streaming
    bool        StartDataStream();      
    bool        StopDataStream();       

    void        ResetPacketTimeOffset(FBTime &pTime);   

    bool        FetchDataPacket(FBTime &pTime);

    //--- Attribute management
    void        SetNetworkUse(bool pUse)                    { mNetworkUse =  pUse;                      }
    bool        GetNetworkUse()                             { return mNetworkUse;                       }
    void        SetNetworkAddress   (const char *pIPAddress){ mNetworkAddress =  pIPAddress;            }
    const char* GetNetworkAddress   ()                      { return mNetworkAddress;           }
    void        SetNetworkPort      (int pPort)             { mNetworkPort = pPort;                     }
    int         GetNetworkPort      ()                      { return mNetworkPort;                      }
    const char* GetMarkerName       (int pMarkerIndex)      { return mMarkerName[pMarkerIndex]; }
    int         GetMarkerCount      ()                      { return mMarkerCount;                      }

    //--- Device data
    double      GetDataX            (int pMarker)           { return mDataBuffer.mMarkerData[pMarker][0];           }
    double      GetDataY            (int pMarker)           { return mDataBuffer.mMarkerData[pMarker][1];           }
    double      GetDataZ            (int pMarker)           { return mDataBuffer.mMarkerData[pMarker][2];           }
    double      GetDataO            (int pMarker)           { return mDataBuffer.mMarkerData[pMarker][3];           }

private:
    FBString    mMarkerName[MAX_MARKER];                    
    sDataBuffer mDataBuffer;                                
    int         mMarkerCount;                               
    nsTime      mPacketTimeOffset;                          
    FBTime      mStartRecordingTime;                        

    FBTime      mLastSimulationTime;                        
    int         mPassCount;                                 

    bool        mNetworkUse;                                
    FBString    mNetworkAddress;                            
    int         mNetworkPort;                               
    FBSystem    mSystem;

    int         mSocket;                                    
    FBTCPIP     mTCP;                                       
};

#endif /* __ORDEVICE_OPTICAL_HARDWARE_H__ */