iufPulse.h File Reference

#include <iufTypes.h>

Go to the source code of this file.

Macros
#define	IUP_INVALID   (iup_t) NULL

Typedefs
typedef IufPulse *	iup_t

Enumerations
enum	IufPulseType { IUF_INVALID_PULSETYPE = 0, IUF_PARAMETRIC_PULSETYPE, IUF_NON_PARAMETRIC_PULSETYPE }

Functions
int	iufPulseDelete (iup_t pulse)
	Deletes a IufPulse object. More...
IUF_BOOL	iufPulseCompare (iup_t reference, iup_t actual)
	Compare two IufPulse objects with each other. More...
IufPulseType	iufPulseGetType (iup_t pulse)
	Get the IufPulse type , i.e. IUF_PARAMETRIC_PULSETYPE or IUF_NON_PARAMETRIC_PULSETYPE. More...

Macro Definition Documentation

IUP_INVALID

#define IUP_INVALID   (iup_t) NULL

Typedef Documentation

iup_t

typedef IufPulse* iup_t

The pulse describes a waveform of the transmit pulse as a function of time and can be described parametric or as a piecewise linear approximation using a list of [time,value] pairs. See IufParametricPulse and IufNonParametricPulse for details. Use the specific functions iufParametricPulseCreate() and iufNonParametricPulseCreate() to construct a pulse.

Enumeration Type Documentation

IufPulseType

enum IufPulseType

Enumerator
IUF_INVALID_PULSETYPE
IUF_PARAMETRIC_PULSETYPE
IUF_NON_PARAMETRIC_PULSETYPE

Function Documentation

iufPulseCompare()

IUF_BOOL iufPulseCompare	(	iup_t	reference,
		iup_t	actual
	)

Compare two IufPulse objects with each other.

Returns

Returns IUF_TRUE when the IufPulse objects are equal and IUF_FALSE otherwise.

Parameters

reference	The IufPulse to compare to
actual	The IufPulse to compare with

iufPulseDelete()

int iufPulseDelete

(

iup_t

pulse

)

Deletes a IufPulse object.

Returns

Returns IUF_E_OK in case of success and IUF_ERR_VALUE in case of an error

Parameters

pulse

The IufPulse of interest.

iufPulseGetType()

IufPulseType iufPulseGetType

(

iup_t

pulse

)

Get the IufPulse type , i.e. IUF_PARAMETRIC_PULSETYPE or IUF_NON_PARAMETRIC_PULSETYPE.

Returns

Returns the pulse type of pulse.

Parameters

pulse

The IufPulse of interest