iufParametricPulse.h File Reference

#include <iufTypes.h>

Go to the source code of this file.

Macros
#define	IUPP_INVALID   (iupp_t) NULL

Typedefs
typedef IufParametricPulse *	iupp_t

Functions
iupp_t	iufParametricPulseCreate (float pulseFrequency, float pulseAmplitude, int numPulses)
int	iufParametricPulseDelete (iupp_t pulse)
IUF_BOOL	iufParametricPulseCompare (iupp_t reference, iupp_t actual)
float	iufParametricPulseGetFrequency (iupp_t pulse)
float	iufParametricPulseGetPulseAmplitude (iupp_t pulse)
int	iufParametricPulseGetNumPulses (iupp_t transmitPulse)

Macro Definition Documentation

IUPP_INVALID

#define IUPP_INVALID   (iupp_t) NULL

Typedef Documentation

iupp_t

typedef IufParametricPulse* iupp_t

Function Documentation

iufParametricPulseCompare()

IUF_BOOL iufParametricPulseCompare	(	iupp_t	reference,
		iupp_t	actual
	)

Compares two parametric pulses. It doesn't matter which is the reference and the actual. /return

Parameters

reference	when comparing two parametric pulses: the reference
actual	when comparing two parametric pulses: the pulse to compare with the reference

iufParametricPulseCreate()

iupp_t iufParametricPulseCreate	(	float	pulseFrequency,
		float	pulseAmplitude,
		int	numPulses
	)

Create the parametric pulse that is described by a sinusoid with the three parameters: frequency, amplitude and number of periods

/return the created pulse

Parameters

pulseFrequency	The frequency in Hz of the transmitted sinusoid
pulseAmplitude	The Amplitude of the pulse in Volt
numPulses	The number of periods the pulse.

iufParametricPulseDelete()

int iufParametricPulseDelete

(

iupp_t

pulse

)

Deletes a parametric pulse

Parameters

pulse

The paramteric pulse to be deleted

iufParametricPulseGetFrequency()

float iufParametricPulseGetFrequency

(

iupp_t

pulse

)

Parameters

pulse

Returns the frequency in Hz of this pararmetric pulse

iufParametricPulseGetNumPulses()

int iufParametricPulseGetNumPulses

(

iupp_t

transmitPulse

)

Parameters

transmitPulse

Returns the number of periods that this pararmetric pulse has

iufParametricPulseGetPulseAmplitude()

float iufParametricPulseGetPulseAmplitude

(

iupp_t

pulse

)

Parameters

pulse

Returns the amplitude in Hz of this pararmetric pulse