MotionBuilder-SDK/cpp_ref/devices_2device_template_2ordevice_template_hardware_8h-example.html

#ifndef __ORDEVICE_TEMPLATE_HARDWARE_H__

#define __ORDEVICE_TEMPLATE_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.

***************************************************************************************/


//--- SDK include

#include <fbsdk/fbsdk.h>


//--- Array size defines

#define MAX_BUFFER_SIZE     2048

#define MAX_DATA_SIZE       12

#define MAX_INFO_SIZE       4

#define MAX_REQUEST_SIZE    4


//--- Communication protocol defines

#define BYTE_HEADER         0x3c

#define BYTE_INFO_PACKET    0x49

#define BYTE_DATA_PACKET    0x44

#define BYTE_STREAM_START   0x41

#define BYTE_STREAM_STOP    0x42

#define BYTE_TRAILER        0x3e


enum ORReadState

{

    eORReadStateHeader,

    eORReadStateType,

    eORReadStateData,

    eORReadStateCRC,

    eORReadStateTrailer

};


class ORDevice_Template;


class ORDevice_Template_Hardware

{

public:

    ORDevice_Template_Hardware();

    ~ORDevice_Template_Hardware();


    void        SetParent(FBDevice* pParent);


    //--- Communications

    bool        Open();

    bool        Close();

    int         FetchData           ();

    bool        PollData            ();


    //--- Attribute management

    void        SetStreaming        (bool pStreaming)       {   mStreaming = pStreaming;        }

    bool        GetStreaming        ()                      {   return mStreaming;              }

    void        SetCommunicationType(FBCommType pType);

    int         GetCommunicationType();

    void        SetNetworkAddress   (const char* pIPAddress){   mNetworkAddress =  pIPAddress;  }

    const char* GetNetworkAddress   ()                      {   return mNetworkAddress; }

    void        SetNetworkPort      (int pPort)             {   mNetworkPort = pPort;           }

    int         GetNetworkPort      ()                      {   return mNetworkPort;            }

    void        SetSerialPort       (int pPort)             {   mSerialPort = pPort;            }

    int         GetSerialPort       ()                      {   return mSerialPort;             }

    void        SetSerialBaudRate   (int pRate)             {   mSerialBaudRate = pRate;        }

    int         GetSerialBaudRate   ()                      {   return mSerialBaudRate;         }


    //--- Device interaction

    bool        GetSetupInfo        ();

    bool        StartStream         ();

    bool        StopStream          ();


    //--- Hardware abstraction of device positional information

    void        GetPosition         ( double* pPos );

    void        GetRotation         ( double* pRot );


    //--- Abstraction of communication type read/write functions

    bool        WriteData           ( unsigned char* pBuffer, int pSize, int* pNumberOfBytesWritten=NULL    );

    bool        ReadData            ( unsigned char* pBuffer, int pSize, int* pNumberOfBytesRead=NULL       );

    void        EmptyBuffer         ();


    //--- Simulator functions

    void        SetFrequency        ( double pFrequency )   { mFrequency = pFrequency;      }

    double      GetFrequency        ()                      { return mFrequency;            }

    void        SetAmplitude        ( double pAmplitude )   { mAmplitude = pAmplitude;      }

    double      GetAmplitude        ()                      { return mAmplitude;            }


private:

    //--- Utility members

    FBSystem        mSystem;

    FBDevice*       mParent;


    //--- Data extraction members

    ORReadState     mReadState;

    unsigned char   mBuffer [ MAX_BUFFER_SIZE   ];

    unsigned char   mData   [ MAX_DATA_SIZE     ];

    unsigned char   mRequest[ MAX_REQUEST_SIZE  ];

    int             mDataCount;


    //--- Communications members

    FBCommPort      mCommPort;

    FBTCPIP         mTCPIP;

    int             mNetworkSocket;

    FBString        mNetworkAddress;

    int             mNetworkPort;

    int             mSerialPort;

    int             mSerialBaudRate;

    bool            mStreaming;


    //--- Device channel status

    double          mPosition[3];

    double          mRotation[3];


    //--- Simulator values

    double          mFrequency;

    double          mAmplitude;


};


#endif /* __ORDEVICE_TEMPLATE_HARDWARE_H__ */