iuf3DNonParametricSource.h File Reference

#include "iufPosition.h"

Go to the source code of this file.

Macros
#define	IU3DNPS_INVALID   (iu3dnps_t) NULL

Typedefs
typedef Iuf3DNonParametricSource *	iu3dnps_t

Functions
iu3dnps_t	iuf3DNonParametricSourceCreate (int numLocations)
int	iuf3DNonParametricSourceDelete (iu3dnps_t source)
	Delete a 3D non-parametric source. More...
int	iuf3DNonParametricSourceCompare (iu3dnps_t reference, iu3dnps_t actual)
	Compares two 3D non-parametric sources. More...
iu3dp_t	iuf3DNonParametricSourceGetPosition (iu3dnps_t source, int index)
	Gets the index -th 3D position of a 3D non-parametric source. More...
int	iuf3DNonParametricSourceGetNumLocations (iu3dnps_t source)
	Gets he number of points the source has. More...
int	iuf3DNonParametricSourceSetPosition (iu3dnps_t source, iu3dp_t pos, int index)
	Sets the 3D position pos on the index -th location for the 3D non-parametric source iuf3DNonParametricSource. More...

Macro Definition Documentation

IU3DNPS_INVALID

#define IU3DNPS_INVALID   (iu3dnps_t) NULL

Typedef Documentation

iu3dnps_t

typedef Iuf3DNonParametricSource* iu3dnps_t

The 3D Non-Parametric Sources describes a list of locations from which a pulse originates simulatanously. You can create a source with a predefined number of locations and the get and set these locations with iuf3DNonParametricSourceGetPosition() and iuf3DNonParametricSourceGetPosition() respectively.

Function Documentation

iuf3DNonParametricSourceCompare()

int iuf3DNonParametricSourceCompare	(	iu3dnps_t	reference,
		iu3dnps_t	actual
	)

Compares two 3D non-parametric sources.

Returns

IUF_TRUE if reference and actual are identical sources, and IUF_FALSE in all other cases.

Parameters

reference	3D non-parametric source to compare
actual	2D non-parametric source to compare with

iuf3DNonParametricSourceCreate()

iu3dnps_t iuf3DNonParametricSourceCreate

(

int

numLocations

)

An invalid 3D Non-Parametric Source

Parameters

numLocations

The number of points the source has.

iuf3DNonParametricSourceDelete()

int iuf3DNonParametricSourceDelete

(

iu3dnps_t

source

)

Delete a 3D non-parametric source.

Returns

Returns IUF_E_OK on success or IUF_ERR_VALUE in case of an error.

Parameters

source

The source that is deleted

iuf3DNonParametricSourceGetNumLocations()

int iuf3DNonParametricSourceGetNumLocations

(

iu3dnps_t

source

)

Gets he number of points the source has.

Returns

The number of points the source has.

Parameters

source

2D non-parametric source with positions

iuf3DNonParametricSourceGetPosition()

iu3dp_t iuf3DNonParametricSourceGetPosition	(	iu3dnps_t	source,
		int	index
	)

Gets the index -th 3D position of a 3D non-parametric source.

Returns

The 3D position or IU3DP_INVALID if that position does not exist.

Parameters

source	3D non-parametric source with positions
index	the index of the position list

iuf3DNonParametricSourceSetPosition()

int iuf3DNonParametricSourceSetPosition	(	iu3dnps_t	source,
		iu3dp_t	pos,
		int	index
	)

Sets the 3D position pos on the index -th location for the 3D non-parametric source iuf3DNonParametricSource.

Returns

Returns IUF_E_OK on success or IUF_ERR_VALUE in case of an error.

Parameters

source	the 3D non-parametric source
pos	the 3D position to be set
index	the index of the position