TAPsSensAble_hduRecord.hpp

Go to the documentation of this file.

/******************************************************************************
TAPsSensAble_hduRecord.hpp

Modified from SensAble hduRecord.h

SUKITTI PUNAK   (11/27/2006)
UPDATE          (11/27/2006)
******************************************************************************/

// Original comment from hduRecord.h
/*****************************************************************************

Copyright (c) 2004 SensAble Technologies, Inc. All rights reserved.

OpenHaptics(TM) toolkit. The material embodied in this software and use of
this software is subject to the terms and conditions of the clickthrough
Development License Agreement.

For questions, comments or bug reports, go to forums at: 
    http://dsc.sensable.com

Module Name:

  hduRecord.h 

Description: 

  Records device data from the scheduler for a specified number of ticks, and 
  with option to add additional user data.
******************************************************************************/
#ifndef TAPs_SENSABLE_HDU_RECORD_HPP
#define TAPs_SENSABLE_HDU_RECORD_HPP

#include <HD/hdDefines.h>
#include <stdio.h>

BEGIN_NAMESPACE_TAPs__Haptic
//=============================================================================

#ifdef __cplusplus 
extern "C" {
#endif  

/******************************************************************************
 For record/playback operations, appends the returned string to the data 
 for each frame.  User is responsible for allocating and deallocating 
 the string.
******************************************************************************/
typedef char * SensAble_HDURecordCallback ( void * pUserData );
    
/******************************************************************************
 Start a recording session.  Records for nData ticks, writes results to file.
 pCallback is an optional user callback called each tick to append any
 additional information.  
 Returns false if recording could not be started.
******************************************************************************/
HDSchedulerHandle SensAble_hduStartRecord (
    FILE *                      file,
    SensAble_HDURecordCallback  pCallback, 
    void *                      pCallbackData,
    unsigned int                nData
);

#ifdef __cplusplus
}
#endif
//=============================================================================
END_NAMESPACE_TAPs__Haptic
//-----------------------------------------------------------------------------
// Include definition if TAPs_USE_EXPORT is not defined
#if !defined( TAPs_USE_EXPORT )
    #include "TAPsSensAble_hduRecord.cpp"
#endif
//-----------------------------------------------------------------------------
#endif  /* TAPs_SENSABLE_HDU_RECORD_HPP */
//34567890123456789012345678901234567890123456789012345678901234567890123456789
//--+----1----+----2----+----3----+----4----+----5----+----6----+----7----+----