OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
DataConnect Class Reference

#include <DataConnect.h>

Inheritance diagram for DataConnect:
Collaboration diagram for DataConnect:

Public Types

typedef std::vector< DataSource * > container_t
typedef container_t::iterator iterator
typedef container_t::const_iterator const_iterator

Public Member Functions

 DataConnect (const char *nm, const char *id, int dtm=DataSource::OUTPUT, int n=0)
virtual ~DataConnect ()
const char * DSID () const
int getDefaultTransferMethod () const
void setDefaultTransferMethod (int m)
int getNodes () const
bool onConnectNode () const
iterator begin ()
iterator end ()
const_iterator begin () const
const_iterator end () const
unsigned int size () const
unsigned int numDataSources () const
bool empty () const
virtual bool connected () const
virtual DataConnectconnect (const char *, DataSource *, int=DataSource::DEFAULT)
virtual DataConnectconnect (const char *, DataSource &, int=DataSource::DEFAULT)
virtual bool connect (DataSourceObject *)
virtual void updateConnections (DataConnect *=0)
virtual void disconnectConnections ()
virtual void interact (const char *=0, DataConnect *=0)
virtual void ready ()
const char * name () const
const char * setName (const char *nm=0)

Private Member Functions

bool checkin (DataSource *)
bool checkout (DataSource *, bool=true)

Private Attributes

std::string MyID
container_t SourceList
int nodes
int DefTransMethod
std::string MyName

Friends

class DataSource

Detailed Description

Definition at line 32 of file DataConnect.h.

Member Typedef Documentation

◆ const_iterator

typedef container_t::const_iterator DataConnect::const_iterator

Definition at line 38 of file DataConnect.h.

◆ container_t

typedef std::vector<DataSource *> DataConnect::container_t

Definition at line 36 of file DataConnect.h.

◆ iterator

typedef container_t::iterator DataConnect::iterator

Definition at line 37 of file DataConnect.h.

Constructor & Destructor Documentation

◆ DataConnect()

DataConnect::DataConnect ( const char * nm,
const char * id,
int dtm = DataSource::OUTPUT,
int n = 0 )

Definition at line 37 of file DataConnect.cpp.

References DefTransMethod, DataConnectCreator::getDefaultNodes(), MyID, NamedObj::NamedObj(), and nodes.

Referenced by connect(), connect(), FileDataConnect::FileDataConnect(), interact(), and updateConnections().

Here is the call graph for this function:

◆ ~DataConnect()

DataConnect::~DataConnect ( )
virtual

Definition at line 47 of file DataConnect.cpp.

References disconnectConnections().

Here is the call graph for this function:

Member Function Documentation

◆ begin() [1/2]

iterator DataConnect::begin ( )
inline

◆ begin() [2/2]

const_iterator DataConnect::begin ( ) const
inline

Definition at line 74 of file DataConnect.h.

References SourceList.

◆ checkin()

bool DataConnect::checkin ( DataSource * ds)
private

Definition at line 130 of file DataConnect.cpp.

References a, begin(), DataSource, end(), and SourceList.

Referenced by DataSource::connect().

Here is the call graph for this function:

◆ checkout()

bool DataConnect::checkout ( DataSource * ds,
bool NeedDisconnect = true )
private

Definition at line 147 of file DataConnect.cpp.

References a, begin(), DataSource, DataSource::disconnect(), end(), and SourceList.

Referenced by DataSource::disconnect(), and disconnectConnections().

Here is the call graph for this function:

◆ connect() [1/3]

DataConnect * DataConnect::connect ( const char * nm,
DataSource & s,
int tm = DataSource::DEFAULT )
virtual

Definition at line 81 of file DataConnect.cpp.

References connect(), DataConnect(), and DataSource.

Here is the call graph for this function:

◆ connect() [2/3]

DataConnect * DataConnect::connect ( const char * nm,
DataSource * s,
int tm = DataSource::DEFAULT )
virtual

Definition at line 74 of file DataConnect.cpp.

References DataSource::connect(), connected(), DataConnect(), and DataSource.

Referenced by connect().

Here is the call graph for this function:

◆ connect() [3/3]

bool DataConnect::connect ( DataSourceObject * dso)
virtual

Definition at line 90 of file DataConnect.cpp.

References DataSource::connect(), DataSourceObject::getConnection(), and DataSourceObject::getSource().

Here is the call graph for this function:

◆ connected()

bool DataConnect::connected ( ) const
virtual

Reimplemented in FileDataConnect.

Definition at line 63 of file DataConnect.cpp.

Referenced by connect().

◆ disconnectConnections()

void DataConnect::disconnectConnections ( )
virtual

Definition at line 113 of file DataConnect.cpp.

References checkout(), and SourceList.

Referenced by ~DataConnect().

Here is the call graph for this function:

◆ DSID()

◆ empty()

bool DataConnect::empty ( ) const
inline

Definition at line 84 of file DataConnect.h.

References SourceList.

◆ end() [1/2]

iterator DataConnect::end ( )
inline

Definition at line 72 of file DataConnect.h.

References SourceList.

Referenced by checkin(), checkout(), interact(), and updateConnections().

◆ end() [2/2]

const_iterator DataConnect::end ( ) const
inline

Definition at line 75 of file DataConnect.h.

References SourceList.

◆ getDefaultTransferMethod()

int DataConnect::getDefaultTransferMethod ( ) const
inline

Definition at line 58 of file DataConnect.h.

References DefTransMethod.

◆ getNodes()

int DataConnect::getNodes ( ) const
inline

Definition at line 62 of file DataConnect.h.

References nodes.

Referenced by onConnectNode().

◆ interact()

void DataConnect::interact ( const char * str = 0,
DataConnect * dc = 0 )
virtual

Definition at line 122 of file DataConnect.cpp.

References a, begin(), DataConnect(), and end().

Here is the call graph for this function:

◆ name()

◆ numDataSources()

unsigned int DataConnect::numDataSources ( ) const
inline

Definition at line 83 of file DataConnect.h.

References SourceList.

◆ onConnectNode()

bool DataConnect::onConnectNode ( ) const

Definition at line 55 of file DataConnect.cpp.

References getNodes(), and IpplInfo::myNode().

Here is the call graph for this function:

◆ ready()

void DataConnect::ready ( )
virtual

Definition at line 177 of file DataConnect.cpp.

◆ setDefaultTransferMethod()

void DataConnect::setDefaultTransferMethod ( int m)
inline

Definition at line 59 of file DataConnect.h.

References DefTransMethod.

◆ setName()

const char * NamedObj::setName ( const char * nm = 0)
inlineinherited

Definition at line 38 of file NamedObj.h.

References MyName.

Referenced by ParticleAttribDataSource::ParticleAttribDataSource().

◆ size()

unsigned int DataConnect::size ( ) const
inline

Definition at line 82 of file DataConnect.h.

References SourceList.

Referenced by FileFieldDataSource< T, Dim, M, C >::FileFieldDataSource().

◆ updateConnections()

void DataConnect::updateConnections ( DataConnect * dc = 0)
virtual

Definition at line 105 of file DataConnect.cpp.

References a, begin(), DataConnect(), and end().

Here is the call graph for this function:

◆ DataSource

friend class DataSource
friend

Definition at line 126 of file DataConnect.h.

References DataSource.

Referenced by checkin(), checkout(), connect(), connect(), DataSource, and FileDataConnect::FileDataConnect().

Member Data Documentation

◆ DefTransMethod

int DataConnect::DefTransMethod
private

Definition at line 138 of file DataConnect.h.

Referenced by DataConnect(), getDefaultTransferMethod(), and setDefaultTransferMethod().

◆ MyID

std::string DataConnect::MyID
private

Definition at line 129 of file DataConnect.h.

Referenced by DataConnect(), and DSID().

◆ MyName

std::string NamedObj::MyName
privateinherited

Definition at line 47 of file NamedObj.h.

Referenced by name(), NamedObj(), and setName().

◆ nodes

int DataConnect::nodes
private

Definition at line 135 of file DataConnect.h.

Referenced by DataConnect(), and getNodes().

◆ SourceList

container_t DataConnect::SourceList
private

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