be_mpi.h File Reference

#include <memory>
#include <string>
#include <be_framework_enumeration.h>
#include <be_io_logsheet.h>

Go to the source code of this file.

Namespaces
namespace	BiometricEvaluation
	This software was developed at the National Institute of Standards and Technology (NIST) by employees of the Federal Government in the course of their official duties.
namespace	BiometricEvaluation::MPI
	Common declarations and functions for the MPI-based functionality.

Typedefs
using	BiometricEvaluation::MPI::taskcmd_t = std::underlying_type< TaskCommand >::type
	Storage type for TaskCommand. More...
using	BiometricEvaluation::MPI::taskstat_t = std::underlying_type< TaskStatus >::type
	Storage type for TaskStatus. More...
using	BiometricEvaluation::MPI::msgtag_t = std::underlying_type< MessageTag >::type
	Storage type for MessageTag. More...

Enumerations
enum class	BiometricEvaluation::MPI::TaskCommand : int32_t {   BiometricEvaluation::MPI::Continue = 0 , BiometricEvaluation::MPI::Ignore = 1 , BiometricEvaluation::MPI::Exit = 2 , BiometricEvaluation::MPI::QuickExit = 3 ,   BiometricEvaluation::MPI::TermExit = 4 }
	The command given to an MPI task. More...
enum class	BiometricEvaluation::MPI::TaskStatus : int32_t { BiometricEvaluation::MPI::OK = 0 , BiometricEvaluation::MPI::Failed = 1 , BiometricEvaluation::MPI::Exit = 2 , BiometricEvaluation::MPI::RequestJobTermination = 3 }
	The status of an MPI distributor or receiver task. More...
enum class	BiometricEvaluation::MPI::MessageTag : int32_t { BiometricEvaluation::MPI::Control = 0 , BiometricEvaluation::MPI::Data = 1 , BiometricEvaluation::MPI::OOB = 2 }
	The types of messages sent between MPI task processes. More...

Functions
std::string	BiometricEvaluation::MPI::generateUniqueID ()
	Obtain a unique ID for the current process. More...
void	BiometricEvaluation::MPI::printStatus (const std::string &message)
	Print a status message to stdout. More...
void	BiometricEvaluation::MPI::logEntry (IO::Logsheet &logsheet)
	Send the current log stream to the log device as a debug entry. More...
void	BiometricEvaluation::MPI::logMessage (IO::Logsheet &logsheet, const std::string &message)
	Send a log message to the given Logsheet as a debug entry. More...
std::shared_ptr< BiometricEvaluation::IO::Logsheet >	BiometricEvaluation::MPI::openLogsheet (const std::string &url, const std::string &description)
	Open a Logsheet object for a component of the MPI framework. More...
	BE_FRAMEWORK_ENUMERATION_DECLARATIONS (BiometricEvaluation::MPI::TaskCommand, BE_MPI_TaskCommand_EnumToStringMap)
	BE_FRAMEWORK_ENUMERATION_DECLARATIONS (BiometricEvaluation::MPI::TaskStatus, BE_MPI_TaskStatus_EnumToStringMap)
	BE_FRAMEWORK_ENUMERATION_DECLARATIONS (BiometricEvaluation::MPI::MessageTag, BE_MPI_MessageTag_EnumToStringMap)

Function Documentation

BE_FRAMEWORK_ENUMERATION_DECLARATIONS() [1/3]

BE_FRAMEWORK_ENUMERATION_DECLARATIONS	(	BiometricEvaluation::MPI::TaskCommand	,
		BE_MPI_TaskCommand_EnumToStringMap
	)

BE_FRAMEWORK_ENUMERATION_DECLARATIONS() [2/3]

BE_FRAMEWORK_ENUMERATION_DECLARATIONS	(	BiometricEvaluation::MPI::TaskStatus	,
		BE_MPI_TaskStatus_EnumToStringMap
	)

BE_FRAMEWORK_ENUMERATION_DECLARATIONS() [3/3]

BE_FRAMEWORK_ENUMERATION_DECLARATIONS	(	BiometricEvaluation::MPI::MessageTag	,
		BE_MPI_MessageTag_EnumToStringMap
	)