ESyS-Particle  2.3.4
esys::lsm::SimpleConnectionData Class Reference

#include <GeometryReader.h>

Public Types

typedef SimpleParticleData::Id Id
 
typedef SimpleParticleData::Tag Tag
 

Public Member Functions

 SimpleConnectionData ()
 
 SimpleConnectionData (Id p1Id, Id p2Id, Tag tag)
 
bool operator== (const SimpleConnectionData &particleData) const
 
const IdgetP1Id () const
 
const IdgetP2Id () const
 
const TaggetTag () const
 
void read (std::istream &istream)
 
void write (std::ostream &write) const
 

Private Attributes

Id m_particle1Id
 
Id m_particle2Id
 
Tag m_tag
 

Detailed Description

Represents a connections between a pair of particles.

Member Typedef Documentation

◆ Id

◆ Tag

Constructor & Destructor Documentation

◆ SimpleConnectionData() [1/2]

esys::lsm::SimpleConnectionData::SimpleConnectionData ( )

◆ SimpleConnectionData() [2/2]

esys::lsm::SimpleConnectionData::SimpleConnectionData ( Id  p1Id,
Id  p2Id,
Tag  tag 
)

Member Function Documentation

◆ getP1Id()

const SimpleConnectionData::Id & esys::lsm::SimpleConnectionData::getP1Id ( ) const

References m_particle1Id.

Referenced by operator==(), and write().

Here is the caller graph for this function:

◆ getP2Id()

const SimpleConnectionData::Id & esys::lsm::SimpleConnectionData::getP2Id ( ) const

References m_particle2Id.

Referenced by operator==(), and write().

Here is the caller graph for this function:

◆ getTag()

const SimpleConnectionData::Tag & esys::lsm::SimpleConnectionData::getTag ( ) const

References m_tag.

Referenced by operator==(), and write().

Here is the caller graph for this function:

◆ operator==()

bool esys::lsm::SimpleConnectionData::operator== ( const SimpleConnectionData particleData) const

References getP1Id(), getP2Id(), and getTag().

Here is the call graph for this function:

◆ read()

void esys::lsm::SimpleConnectionData::read ( std::istream &  istream)

References m_particle1Id, m_particle2Id, and m_tag.

Referenced by esys::lsm::operator>>().

Here is the caller graph for this function:

◆ write()

void esys::lsm::SimpleConnectionData::write ( std::ostream &  write) const

References getP1Id(), getP2Id(), and getTag().

Referenced by esys::lsm::operator<<().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ m_particle1Id

Id esys::lsm::SimpleConnectionData::m_particle1Id
private

Referenced by getP1Id(), and read().

◆ m_particle2Id

Id esys::lsm::SimpleConnectionData::m_particle2Id
private

Referenced by getP2Id(), and read().

◆ m_tag

Tag esys::lsm::SimpleConnectionData::m_tag
private

Referenced by getTag(), and read().


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