am_sdvr_train_record.h

Motorola synergy audio component

#ifndef AM_SDVR_TRAIN_RECORD_CLASS_INCLUDE
#define AM_SDVR_TRAIN_RECORD_CLASS_INCLUDE

/* (c) Copyright Motorola 1997, All rights reserved.        
   Motorola Confidential Proprietary
   Contains confidential proprietary information of Motorola, Inc.
   Reverse engineering is prohibited.
   The copyright notice does not imply publication.
  
   DESCRIPTION: 
       This file defines the AM_SDVR_Train_Record class.
 
 ************** REVISION HISTORY **********************************************
  
   Date       Author      Reference
   ========   ========    ==========================
   98-11-04   blamers     CR - CSGce23508
              Whitecap VR Event Handler Changes
              - Rid AM of compiler warning.

   97.06.20   slam        PR - CSGce10240
              - Globally rename repetition_bit_array to repetition_bit_mask.

   97-05-29   slam        PR - CSGce10240
              - Initial release
*/
/************** HEADER FILE INCLUDES ******************************************/
#include <stddef.h>
#ifndef SUAPI_INCLUDE
#include <SUAPI/suapi.h>
#endif
#include "am_sdvr_records.h"

/************** CONSTANTS *****************************************************/

/************** STRUCTURES, ENUMS, AND TYPEDEFS *******************************/

/************** FUNCTION PROTOTYPES *******************************************/

/************** MACROS ********************************************************/

/************** CLASS DEFINITIONS *********************************************/
class AM_SDVR_Train_Record
{
public:

    /*
     * Overload the new and delete operators to prevent calls to the 
     * system's new and delete functions.
     */ 
    inline void * operator new(size_t) { return(NULL); }
    inline void operator delete(void *, size_t) {}

    /*
     * class constructor
     */
    AM_SDVR_Train_Record 
    ( AM_SDVR_TRAIN_RECORD *training_record_ptr );

    /* 
     * class destructor, do nothing, but prevents allocation of __Ptbl in 
     * everyfile that includes this .H file.
     */
    ~AM_SDVR_Train_Record (void) {};
    
    /*
     * clear training record
     */
    void
    clear ( void );

    /*
     * save training data
     */
    void
    save 
    (
     /* group id */
     TD_VR_GROUP_TYPE group_id,

     /* training mode */
     TD_VR_TRAINING_TYPE training_mode,

     /* repetition bit mask */
     UINT16 repetition_bit_mask
     );

    /*
     * return group id
     */
    inline TD_VR_GROUP_TYPE get_group_id ( void )
	{
		return( training_ptr->group_id );
	}

    /*
     * return training mode
     */
    inline TD_VR_TRAINING_TYPE get_training_mode ( void )
	{
		return( training_ptr->training_mode );
	}

    /*
     * return repetition bit mask
     */
    inline UINT16 get_repetition_bit_mask ( void )
	{
		return( training_ptr->repetition_bit_mask );
	}


private:

   AM_SDVR_TRAIN_RECORD *training_ptr;
};

#endif //end of AM_SDVR_TRAIN_RECORD_CLASS_INCLUDE