MoMeshPointProbe::MoProbeCallback Class Reference

This class specifies the interface used by this node to notify the application when the position of the probe is updated. More...

Public Member Functions
virtual void	motionCallback (size_t cellId, const MeXScalardSetI &scalars, const MeXVec3dSetI &vectors)
virtual void	motionCallback (size_t cellIdI, size_t cellIdJ, const MeXScalardSetI &scalars, const MeXVec3dSetI &vectors)
virtual void	motionCallback (size_t cellIdI, size_t cellIdJ, size_t cellIdK, const MeXScalardSetI &scalars, const MeXVec3dSetI &vectors)
virtual	~MoProbeCallback ()

Detailed Description

This class specifies the interface used by this node to notify the application when the position of the probe is updated.

A derived class must implement at least one of the event method motionCallback depending on the type of mesh.

virtual MoMeshPointProbe::MoProbeCallback::~MoProbeCallback ( ) [inline, virtual]

virtual void MoMeshPointProbe::MoProbeCallback::motionCallback	(	size_t	cellIdI,
		size_t	cellIdJ,
		size_t	cellIdK,
		const MeXScalardSetI &	scalars,
		const MeXVec3dSetI &	vectors
	)			`[inline, virtual]`

Callback that is triggered each time the field MoMeshPointProbe::position changes on a structured IJK mesh.

Parameters:

`[in]`	cellIdI	is the index I of the cell in which the probe is located.
`[in]`	cellIdJ	is the index J of the cell in which the probe is located.
`[in]`	cellIdK	is the index K of the cell in which the probe is located.
`[in]`	scalars	is a set of probed scalar values from the selected scalar sets at the current position. The number of scalar values corresponds to the number of indices in scalarSetIds. The ith value in scalars is associated with the ith index in scalarSetIds.
`[in]`	vectors	is a set of probed vectors from the selected vector sets at the current position. The number of vectors corresponds to the number of indices in vectorSetIds. The ith element in vectors is associated with the ith index in vectorSetIds.

Note:: when the probe is outside the mesh, cellIdI, cellIdJ and cellIdK equal -1 and the scalars and vectors parameters are empty.

virtual void MoMeshPointProbe::MoProbeCallback::motionCallback	(	size_t	cellIdI,
		size_t	cellIdJ,
		const MeXScalardSetI &	scalars,
		const MeXVec3dSetI &	vectors
	)			`[inline, virtual]`

Callback that is triggered each time the field MoMeshPointProbe::position changes on a structured IJ mesh.

Parameters:

`[in]`	cellIdI	is the index I of the cell in which the probe is located.
`[in]`	cellIdJ	is the index J of the cell in which the probe is located.
`[in]`	scalars	is a set of probed scalar values from the selected scalar sets at the current position. The number of scalar values corresponds to the number of indices in scalarSetIds. The ith value in scalars is associated with the ith index in scalarSetIds.
`[in]`	vectors	is a set of probed vectors from the selected vector sets at the current position. The number of vectors corresponds to the number of indices in vectorSetIds. The ith element in vectors is associated with the ith index in vectorSetIds.

Note:: when the probe is outside the mesh, cellIdI and cellIdJ equal -1 and the scalars and vectors parameters are empty.

virtual void MoMeshPointProbe::MoProbeCallback::motionCallback	(	size_t	cellId,
		const MeXScalardSetI &	scalars,
		const MeXVec3dSetI &	vectors
	)			`[inline, virtual]`

Callback that is triggered each time the field MoMeshPointProbe::position changes on a unstructured mesh.

Parameters:

`[in]`	cellId	is the index of the cell in which the probe is located.
`[in]`	scalars	is a set of probed scalar values from the selected scalar sets at the current position. The number of scalar values corresponds to the number of indices in scalarSetIds. The ith value in scalars is associated with the ith index in scalarSetIds.
`[in]`	vectors	is a set of probed vectors from the selected vector sets at the current position. The number of vectors corresponds to the number of indices in vectorSetIds. The ith element in vectors is associated with the ith index in vectorSetIds.

Note:: when the probe is outside the mesh, cellId equals -1 and the scalars and vectors parameters are empty.

The documentation for this class was generated from the following file: