OPAL (Object Oriented Parallel Accelerator Library) 2024.2
OPAL
Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
FileDataConnect Class Reference

#include <FileDataConnect.h>

Inheritance diagram for FileDataConnect:
Inheritance graph
Collaboration diagram for FileDataConnect:
Collaboration graph

Public Types

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

Public Member Functions

 FileDataConnect (const char *nm, unsigned int numobjs=1, const char *ts=0, int n=0)
 
virtual ~FileDataConnect ()
 
unsigned int getNumObjects () const
 
const char * getTypeString () const
 
virtual bool connected () const
 
const char * DSID () const
 
int getDefaultTransferMethod () const
 
void setDefaultTransferMethod (int m)
 
int getNodes () const
 
bool onConnectNode () const
 
iterator begin ()
 
const_iterator begin () const
 
iterator end ()
 
const_iterator end () const
 
unsigned int size () const
 
unsigned int numDataSources () const
 
bool empty () const
 
virtual DataConnect * connect (const char *, DataSource *, int=DataSource::DEFAULT)
 
virtual DataConnect * connect (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

unsigned int NumObjects
 
std::string TypeString
 
std::string MyID
 
container_t SourceList
 
int nodes
 
int DefTransMethod
 
std::string MyName
 

Detailed Description

Definition at line 25 of file FileDataConnect.h.

Member Typedef Documentation

◆ const_iterator

typedef container_t::const_iterator DataConnect::const_iterator
inherited

Definition at line 38 of file DataConnect.h.

◆ container_t

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

Definition at line 36 of file DataConnect.h.

◆ iterator

typedef container_t::iterator DataConnect::iterator
inherited

Definition at line 37 of file DataConnect.h.

Constructor & Destructor Documentation

◆ FileDataConnect()

FileDataConnect::FileDataConnect ( const char *  nm,
unsigned int  numobjs = 1,
const char *  ts = 0,
int  n = 0 
)
inline

Definition at line 29 of file FileDataConnect.h.

References TypeString.

◆ ~FileDataConnect()

virtual FileDataConnect::~FileDataConnect ( )
inlinevirtual

Definition at line 39 of file FileDataConnect.h.

Member Function Documentation

◆ begin() [1/2]

iterator DataConnect::begin ( )
inlineinherited

Definition at line 71 of file DataConnect.h.

References DataConnect::SourceList.

Referenced by DataConnect::checkin(), DataConnect::checkout(), FileFieldDataSource< T, Dim, M, C >::FileFieldDataSource(), DataConnect::interact(), and DataConnect::updateConnections().

◆ begin() [2/2]

const_iterator DataConnect::begin ( ) const
inlineinherited

Definition at line 74 of file DataConnect.h.

References DataConnect::SourceList.

◆ checkin()

bool DataConnect::checkin ( DataSource *  ds)
privateinherited

Definition at line 130 of file DataConnect.cpp.

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

Referenced by DataSource::connect().

Here is the call graph for this function:

◆ checkout()

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

Definition at line 147 of file DataConnect.cpp.

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

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

Here is the call graph for this function:

◆ connect() [1/3]

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

Definition at line 81 of file DataConnect.cpp.

References DataConnect::connect().

Here is the call graph for this function:

◆ connect() [2/3]

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

Definition at line 74 of file DataConnect.cpp.

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

Referenced by DataConnect::connect().

Here is the call graph for this function:

◆ connect() [3/3]

bool DataConnect::connect ( DataSourceObject *  dso)
virtualinherited

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()

virtual bool FileDataConnect::connected ( ) const
inlinevirtual

Reimplemented from DataConnect.

Definition at line 56 of file FileDataConnect.h.

◆ disconnectConnections()

void DataConnect::disconnectConnections ( )
virtualinherited

Definition at line 113 of file DataConnect.cpp.

References DataConnect::checkout(), and DataConnect::SourceList.

Referenced by DataConnect::~DataConnect().

Here is the call graph for this function:

◆ DSID()

const char * DataConnect::DSID ( ) const
inlineinherited

Definition at line 55 of file DataConnect.h.

References DataConnect::MyID.

Referenced by FileFieldDataSource< T, Dim, M, C >::FileFieldDataSource(), FileIpplParticleBaseDataSource< T >::FileIpplParticleBaseDataSource(), FileParticleAttribDataSource< T >::FileParticleAttribDataSource(), and make_DataSourceObject().

◆ empty()

bool DataConnect::empty ( ) const
inlineinherited

Definition at line 84 of file DataConnect.h.

References DataConnect::SourceList.

◆ end() [1/2]

iterator DataConnect::end ( )
inlineinherited

Definition at line 72 of file DataConnect.h.

References DataConnect::SourceList.

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

◆ end() [2/2]

const_iterator DataConnect::end ( ) const
inlineinherited

Definition at line 75 of file DataConnect.h.

References DataConnect::SourceList.

◆ getDefaultTransferMethod()

int DataConnect::getDefaultTransferMethod ( ) const
inlineinherited

Definition at line 58 of file DataConnect.h.

References DataConnect::DefTransMethod.

Referenced by DataSource::connect().

◆ getNodes()

int DataConnect::getNodes ( ) const
inlineinherited

Definition at line 62 of file DataConnect.h.

References DataConnect::nodes.

Referenced by DataConnect::onConnectNode().

◆ getNumObjects()

unsigned int FileDataConnect::getNumObjects ( ) const
inline

Definition at line 46 of file FileDataConnect.h.

References NumObjects.

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

◆ getTypeString()

const char * FileDataConnect::getTypeString ( ) const
inline

Definition at line 49 of file FileDataConnect.h.

References TypeString.

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

◆ interact()

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

Definition at line 122 of file DataConnect.cpp.

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

Here is the call graph for this function:

◆ name()

const char * NamedObj::name ( ) const
inlineinherited

Definition at line 35 of file NamedObj.h.

References NamedObj::MyName.

Referenced by FileFieldDataSource< T, Dim, M, C >::FileFieldDataSource(), FileIpplParticleBaseDataSource< T >::FileIpplParticleBaseDataSource(), FileParticleAttribDataSource< T >::FileParticleAttribDataSource(), and ParticleAttribDataSource::ParticleAttribDataSource().

◆ numDataSources()

unsigned int DataConnect::numDataSources ( ) const
inlineinherited

Definition at line 83 of file DataConnect.h.

References DataConnect::SourceList.

◆ onConnectNode()

bool DataConnect::onConnectNode ( ) const
inherited

Definition at line 55 of file DataConnect.cpp.

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

Here is the call graph for this function:

◆ ready()

void DataConnect::ready ( )
virtualinherited

Definition at line 177 of file DataConnect.cpp.

◆ setDefaultTransferMethod()

void DataConnect::setDefaultTransferMethod ( int  m)
inlineinherited

Definition at line 59 of file DataConnect.h.

References DataConnect::DefTransMethod.

◆ setName()

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

Definition at line 38 of file NamedObj.h.

References NamedObj::MyName.

Referenced by ParticleAttribDataSource::ParticleAttribDataSource().

◆ size()

unsigned int DataConnect::size ( void  ) const
inlineinherited

Definition at line 82 of file DataConnect.h.

References DataConnect::SourceList.

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

◆ updateConnections()

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

Definition at line 105 of file DataConnect.cpp.

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

Here is the call graph for this function:

Member Data Documentation

◆ DefTransMethod

int DataConnect::DefTransMethod
privateinherited

Definition at line 138 of file DataConnect.h.

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

◆ MyID

std::string DataConnect::MyID
privateinherited

Definition at line 129 of file DataConnect.h.

Referenced by DataConnect::DSID().

◆ MyName

std::string NamedObj::MyName
privateinherited

Definition at line 47 of file NamedObj.h.

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

◆ nodes

int DataConnect::nodes
privateinherited

Definition at line 135 of file DataConnect.h.

Referenced by DataConnect::DataConnect(), and DataConnect::getNodes().

◆ NumObjects

unsigned int FileDataConnect::NumObjects
private

Definition at line 60 of file FileDataConnect.h.

Referenced by getNumObjects().

◆ SourceList

container_t DataConnect::SourceList
privateinherited

Definition at line 132 of file DataConnect.h.

Referenced by DataConnect::begin(), DataConnect::checkin(), DataConnect::checkout(), DataConnect::disconnectConnections(), DataConnect::empty(), DataConnect::end(), DataConnect::numDataSources(), and DataConnect::size().

◆ TypeString

std::string FileDataConnect::TypeString
private

Definition at line 61 of file FileDataConnect.h.

Referenced by FileDataConnect(), and getTypeString().

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