SENSEI
A frame work for generic in situ analytics
sensei::InTransitAdaptorFactory Namespace Reference

Factory methods for creating in transit adaptors from XML. More...

Functions

int Initialize (MPI_Comm comm, const std::string &fileName, InTransitDataAdaptor *&dataAdaptor)
 Creates a sensei::ConfigurableAnalysis adaptor and sensei::InTransitDataAdaptor based on a SENSEI XML config file. More...
 
int Initialize (MPI_Comm comm, const pugi::xml_node &root, InTransitDataAdaptor *&dataAdaptor)
 Creates a sensei::ConfigurableAnalysis adaptor and sensei::InTransitDataAdaptor based on a SENSEI XML config file. More...
 

Detailed Description

Factory methods for creating in transit adaptors from XML.

Function Documentation

◆ Initialize() [1/2]

int sensei::InTransitAdaptorFactory::Initialize ( MPI_Comm  comm,
const std::string &  fileName,
InTransitDataAdaptor *&  dataAdaptor 
)

Creates a sensei::ConfigurableAnalysis adaptor and sensei::InTransitDataAdaptor based on a SENSEI XML config file.

The factory will be used in in transit end-points.

The factory uses the 'type' attribute to construct the appropriate InTransitDataAdaptor instance and initializes it with the data_adaptor element. See InTranistDataAdaptor::Initialize for details.

The factory forwards analysis XML to the configurable analysis instance.

The supported transport types are:

adios1 adios2 hdf5 libis

Illustrative example of the XML:

<sensei>
<data_adaptor transport="adios2" partitioner="block" ... >
...
</data_adaptor>
<analysis type="histogram" ... >
...
</analysis>
...
<sensei>

◆ Initialize() [2/2]

int sensei::InTransitAdaptorFactory::Initialize ( MPI_Comm  comm,
const pugi::xml_node &  root,
InTransitDataAdaptor *&  dataAdaptor 
)

Creates a sensei::ConfigurableAnalysis adaptor and sensei::InTransitDataAdaptor based on a SENSEI XML config file.

The factory will be used in in transit end-points.

The factory uses the 'type' attribute to construct the appropriate InTransitDataAdaptor instance and initializes it with the data_adaptor element. See InTranistDataAdaptor::Initialize for details.

The factory forwards analysis XML to the configurable analysis instance.

The supported transport types are:

adios_1 adios_2 data_elevators libis

Illustrative example of the XML:

<sensei>
<data_adaptor transport="adios_2" partitioner="block" ... >
...
</data_adaptor>
<analysis type="histogram" ... >
...
</analysis>
...
<sensei>