mpi

Class Status

java.lang.Object

mpi.Status

public class Status
extends java.lang.Object

This class represents MPI_STATUS.

Field Summary

Fields

Modifier and Type	Field and Description
int	count
int	index For a `waitany()' operation in class `Request'.
boolean	isBufferComms
int	numEls
int	source For a receive operation, the source of the message.
int	tag For a receive operation, the tag in the message.
mpjbuf.Type	type

Constructor Summary

Constructors

Constructor and Description
Status()
Status(boolean isBufferComms)
Status(int source, int tag, int index)

Method Summary

Modifier and Type	Method and Description
void	free() Frees a freeable object.
int	getCount(Datatype datatype) Get the number of received entries.
int	getElements(Datatype datatype) Retrieve number of basic elements from status.
int	getIndex()
int	getSource()
int	getTag()
boolean	isCancelled() Test if communication was cancelled.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

source

public int source

For a receive operation, the source of the message.

tag

public int tag

For a receive operation, the tag in the message.

index

public int index

For a `waitany()' operation in class `Request'.

This field defines which communication in the `reqs' array was selected.

count

public int count

numEls

public int numEls

type

public mpjbuf.Type type

isBufferComms

public boolean isBufferComms

Constructor Detail

Status

public Status()

Status

public Status(boolean isBufferComms)

Status

public Status(int source,
              int tag,
              int index)

Method Detail

getCount

public int getCount(Datatype datatype)
             throws MPIException

Get the number of received entries.

Parameters:

datatype - datatype of each item in receive buffer.

Returns:

number of received entries.

Java binding of the MPI operation MPI_GET_COUNT.

Throws:

MPIException - Points out that an MPI exception has occured.

getSource

public int getSource()

getTag

public int getTag()

getIndex

public int getIndex()

isCancelled

public boolean isCancelled()
                    throws MPIException

Test if communication was cancelled.

Returns:

true if the operation was successfully cancelled, otherwise false.

Java binding of the MPI operation MPI_TEST_CANCELLED.

Throws:

MPIException - Points out that an MPI exception has occured.

free

public void free()

Frees a freeable object.

getElements

public int getElements(Datatype datatype)
                throws MPIException

Retrieve number of basic elements from status.

Parameters:

datatype - datatype used by receive operation.

Returns:

number of received basic elements.

Java binding of the MPI operation MPI_GET_ELEMENTS.

Throws:

MPIException - Points out that an MPI exception has occured.