am_sdvr_recog_record.h

Motorola synergy audio component

#ifndef AM_SDVR_RECOG_RECORD_CLASS_INCLUDE
#define AM_SDVR_RECOG_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_Recog_Record class.

 ************** REVISION HISTORY **********************************************
  
   Date       Author      Reference
   ========   ========    ==========================
   98-11-04   blamers     CR - CSGce23508
              Whitecap VR Event Handler Changes
              - Rid AM of compiler warning.

   97-05-29    slam        PR - CSGce10240
*/
/************** 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_Recog_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_Recog_Record 
    ( AM_SDVR_RECOG_RECORD *recog_record_ptr );

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

    /*
     * save speaker dependent voice recognition data
     */
    void
    save 
    (
     /* group id */
     TD_VR_GROUP_TYPE group_id,

     /* repeat indication */
     BOOL repeat_indication,

     /* nbest */
     UINT8 nbest,

     /* active bit array size in units of UINT16 */
     UINT8 active_bit_array_size,

     /* active bit array */
     UINT16 *active_bit_array,

     /* recognition time in units of ms */
     UINT16 time
     );

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

    /*
     * return repeat indication
     */
    inline BOOL get_repeat_indication ( void )
	{
		return( recog_ptr->repeat_indication );
	}

    /*
     * return nbest
     */
    inline UINT8 get_nbest ( void )
	{
		return( recog_ptr->nbest );
	}

    /*
     * return active bit array size in units of UINT16
     */
    inline UINT8 get_active_bit_array_size ( void )
	{
		return( recog_ptr->active_bit_array_size );
	}

    /*
     * return pointer to the active bit array
     */
    inline UINT16 *get_active_bit_array ( void )
	{
		return( recog_ptr->active_bit_array );
	}

    /*
     * return recognition time in units of ms
     */
    inline UINT16 get_time ( void )
	{
		return( recog_ptr->time );
	}


private:

   AM_SDVR_RECOG_RECORD *recog_ptr;
};

#endif //end of AM_SDVR_RECOG_RECORD_CLASS_INCLUDE