G4Voxel::Index Struct Reference

#include <G4DNAMesh.hh>

Public Member Functions
	Index ()
	Index (int x0, int y0, int z0)
G4bool	operator!= (const Index &rhs) const
Index	operator+ (const Index &rhs) const
G4bool	operator== (const Index &rhs) const

Data Fields
int	x
int	y
int	z

Friends
std::ostream &	operator<< (std::ostream &stream, const Index &rhs)

Detailed Description

Definition at line 44 of file G4DNAMesh.hh.

Constructor & Destructor Documentation

Index() [1/2]

G4Voxel::Index::Index ( )

inline

Definition at line 46 of file G4DNAMesh.hh.

      : x(0)
      , y(0)
      , z(0)
    {}

Index() [2/2]

G4Voxel::Index::Index ( int  x0, int  y0, int  z0  )

inline

Definition at line 51 of file G4DNAMesh.hh.

      : x(x0)
      , y(y0)
      , z(z0)
    {}

Member Function Documentation

operator!=()

G4bool G4Voxel::Index::operator!= ( const Index &  rhs ) const

inline

Definition at line 66 of file G4DNAMesh.hh.

    {
      return x != rhs.x || y != rhs.y || z != rhs.z;
    }

References x, y, and z.

operator+()

Index G4Voxel::Index::operator+ ( const Index &  rhs ) const

inline

Definition at line 70 of file G4DNAMesh.hh.

    {
      return { x + rhs.x, y + rhs.y, z + rhs.z };
    }

References x, y, and z.

operator==()

G4bool G4Voxel::Index::operator== ( const Index &  rhs ) const

inline

Definition at line 62 of file G4DNAMesh.hh.

    {
      return x == rhs.x && y == rhs.y && z == rhs.z;
    }

References x, y, and z.

Friends And Related Function Documentation

operator<<

std::ostream & operator<< ( std::ostream &  stream, const Index &  rhs  )

friend

Definition at line 57 of file G4DNAMesh.hh.

    {
      stream << "(" << rhs.x << ", " << rhs.y << ", " << rhs.z << ")";
      return stream;
    }

Field Documentation

x

int G4Voxel::Index::x

Definition at line 74 of file G4DNAMesh.hh.

Referenced by mcscore.MCVertex::dump_vertex(), G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetBoundingBox(), G4DNAMesh::GetIndex(), G4DNAMesh::GetKey(), operator!=(), operator+(), operator==(), and mcscore.MCVertex::printout().

y

int G4Voxel::Index::y

Definition at line 74 of file G4DNAMesh.hh.

Referenced by mcscore.MCVertex::dump_vertex(), G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetBoundingBox(), G4DNAMesh::GetIndex(), G4DNAMesh::GetKey(), operator!=(), operator+(), operator==(), and mcscore.MCVertex::printout().

z

int G4Voxel::Index::z

Definition at line 74 of file G4DNAMesh.hh.

Referenced by mcscore.MCVertex::dump_vertex(), G4DNAMesh::FindNeighboringVoxels(), G4DNAMesh::FindVoxelNeighbors(), G4DNAMesh::GetBoundingBox(), G4DNAMesh::GetIndex(), G4DNAMesh::GetKey(), operator!=(), operator+(), operator==(), and mcscore.MCVertex::printout().

---

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

• source/processes/electromagnetic/dna/utils/include/G4DNAMesh.hh