float/offset.h

Go to the documentation of this file.

/* --COPYRIGHT--,BSD
 * Copyright (c) 2014, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * --/COPYRIGHT--*/
#ifndef _OFFSET_H_
#define _OFFSET_H_



// **************************************************************************
// the includes

// modules
#include "sw/modules/types/src/types.h"
#include "sw/modules/filter/src/float/filter_fo.h"





#ifdef __cplusplus
extern "C" {
#endif


// **************************************************************************
// the defines


// **************************************************************************
// the typedefs
 
typedef struct _OFFSET_
{

  float_t            value;          
  FILTER_FO_Obj      filter;         
  FILTER_FO_Handle   filterHandle;   

} OFFSET_Obj;


typedef struct _OFFSET_Obj_ *OFFSET_Handle;
                                                         

// **************************************************************************
// the globals


// **************************************************************************
// the function prototypes


extern float_t OFFSET_getBeta(OFFSET_Handle handle);


static inline float_t OFFSET_getOffset(OFFSET_Handle handle)
{
  OFFSET_Obj *obj = (OFFSET_Obj *)handle;

  return(obj->value);
} // end of OFFSET_getOffset() function


extern OFFSET_Handle OFFSET_init(void *pMemory,const size_t numBytes);


static inline void OFFSET_run(OFFSET_Handle handle,const float_t inputValue)
{
  OFFSET_Obj *obj = (OFFSET_Obj *)handle;

  obj->value = FILTER_FO_run(obj->filterHandle,inputValue);

  return;
} // end of OFFSET_run() function


extern void OFFSET_setBeta(OFFSET_Handle handle,const float_t beta_rad);


extern void OFFSET_setInitCond(OFFSET_Handle handle,const float_t initCond);


extern void OFFSET_setOffset(OFFSET_Handle handle, float_t offsetValue);


#ifdef __cplusplus
}
#endif // extern "C"

#endif // end of _OFFSET_H_ definition