Package mpi
Class Info
java.lang.Object
mpi.Info
This class represents
MPI_Info
.-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Java binding of the MPI operationMPI_INFO_DUP
.void
Java binding of the MPI operationMPI_INFO_DELETE
.dup()
Java binding of the MPI operationMPI_INFO_DUP
.void
free()
Java binding of the MPI operationMPI_INFO_FREE
.Java binding of the MPI operationMPI_INFO_GET
.getKey
(int i) Java binding of the MPI operationMPI_INFO_GET_NTHKEY
.boolean
isNull()
Tests if the info object isMPI_INFO_NULL
(has been freed).protected static Info
newEnv()
void
Java binding of the MPI operationMPI_INFO_SET
.int
size()
Java binding of the MPI operationMPI_INFO_GET_NKEYS
.
-
Field Details
-
handle
protected long handle -
NULL
protected static final long NULL
-
-
Constructor Details
-
Info
Java binding of the MPI operationMPI_INFO_CREATE
.- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
Info
protected Info(long handle)
-
-
Method Details
-
newEnv
-
set
Java binding of the MPI operationMPI_INFO_SET
.- Parameters:
key
- keyvalue
- value- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
get
Java binding of the MPI operationMPI_INFO_GET
.- Parameters:
key
- key- Returns:
- value or
null
if key is not defined - Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
delete
Java binding of the MPI operationMPI_INFO_DELETE
.- Parameters:
key
- key- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
size
Java binding of the MPI operationMPI_INFO_GET_NKEYS
.- Returns:
- number of defined keys
- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
getKey
Java binding of the MPI operationMPI_INFO_GET_NTHKEY
.- Parameters:
i
- key number- Returns:
- key
- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
clone
Java binding of the MPI operationMPI_INFO_DUP
.It is recommended to use
dup()
instead ofclone()
because the last can't throw anMPIException
. -
dup
Java binding of the MPI operationMPI_INFO_DUP
.- Returns:
- info object
- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
free
Java binding of the MPI operationMPI_INFO_FREE
.- Specified by:
free
in interfaceFreeable
- Throws:
MPIException
- Signals that an MPI exception of some sort has occurred.
-
isNull
public boolean isNull()Tests if the info object isMPI_INFO_NULL
(has been freed).- Returns:
- true if the info object is
MPI_INFO_NULL
, false otherwise.
-