devices/deviceoptical/ordeviceoptical_hardware.cxx

/***************************************************************************************
 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.
***************************************************************************************/

//--- Class declaration
#include "ordeviceoptical_hardware.h"

/************************************************
 *  Constructor.
 ************************************************/
ORDeviceOptical_Template_Hardware::ORDeviceOptical_Template_Hardware() :
    mMarkerCount( 0 ),
    mPassCount( 0 ),
    mNetworkUse( false ),
    mNetworkPort( PORTNUMBER ),
    mSocket( 0 )
{
    mNetworkAddress = "127.0.0.1";
}


/************************************************
 *  Destructor.
 ************************************************/
ORDeviceOptical_Template_Hardware::~ORDeviceOptical_Template_Hardware()
{
}


/************************************************
 *  Open communication to the client.
 ************************************************/
bool ORDeviceOptical_Template_Hardware::Open()
{
    // TODO: Open network connection to server
    return true;
}


/************************************************
 *  Get client's setup information.
 ************************************************/
bool ORDeviceOptical_Template_Hardware::GetSetupInfo()
{
    // TODO: Get info from server and populate mMarkerName[...]
    mMarkerCount    = 4;
    mMarkerName[0]  = "1";
    mMarkerName[1]  = "2";
    mMarkerName[2]  = "3";
    mMarkerName[3]  = "4";
    return true;
}


/************************************************
 *  Start data streaming.
 ************************************************/
bool ORDeviceOptical_Template_Hardware::StartDataStream()
{
    // TODO: ask server to start sending data

    if (mNetworkUse)
    {
        if (mTCP.CreateSocket(mSocket,kFBTCPIP_Stream ))
        {
            if (!mTCP.Connect(mSocket, mNetworkAddress, mNetworkPort))
            {
                if (mSocket) mTCP.CloseSocket(mSocket);
                mSocket = 0;
            }
        }
        return mSocket!=0;
    }
    return true;
}


/************************************************
 *  Stop data streaming.
 ************************************************/
bool ORDeviceOptical_Template_Hardware::StopDataStream()
{
    // TODO: ask server to stop sending data
    if (mSocket) mTCP.CloseSocket(mSocket);
    mSocket = 0;
    return true;
}


/************************************************
 *  Close network client.
 ************************************************/
bool ORDeviceOptical_Template_Hardware::Close()
{
    // TODO: Close network connection to server
    if (mSocket) mTCP.CloseSocket(mSocket);
    mSocket = 0;
    return true;
}

/************************************************
 *  Take current DataBuffer time as a time offset
 ************************************************/
void ORDeviceOptical_Template_Hardware::ResetPacketTimeOffset(FBTime &pTime)
{
    mPacketTimeOffset = mDataBuffer.mTime;
    mStartRecordingTime = pTime;
}

/************************************************
 *  Fetch a data packet to be read.
 *  Returns true if a new data packet is ready.
 ************************************************/
bool ORDeviceOptical_Template_Hardware::FetchDataPacket(FBTime &pTime)
{
    // If using network server, go and fetch a packet
    if (mSocket)
    {
        int tmpByteCount = 0;
        if (mTCP.Read(mSocket, (char*)&mDataBuffer,sizeof(mDataBuffer), &tmpByteCount))
        {
            if (tmpByteCount!=sizeof(mDataBuffer))
            {
                return false;
            }
        } else
        {
            return false;
        }
    } else 
    // Otherwise use a simulated source
    {
        mPassCount++;
        if(mPassCount % 2==0)
        {
            mLastSimulationTime = mSystem.SystemTime;
            return false; // Nothing else to read.
        }

        mDataBuffer.Simulate((mLastSimulationTime.GetMilliSeconds())*1000000);
        mLastSimulationTime.SetMilliSeconds(mLastSimulationTime.GetMilliSeconds()+(1000/SIM_FPS));
    }
    
    // Update packet relative time
    pTime.SetMilliSeconds((mDataBuffer.mTime-mPacketTimeOffset)/1000000);
    pTime += mStartRecordingTime;
    return true;
}