pscfpp.file.File Class Reference

Class that contains metadata for a file. More...

Inheritance diagram for pscfpp.file.File:

Public Member Functions
def	__init__ (self, path=None, scan=1)
	Constructor. More...
def	__str__ (self)
	String representation of file data. More...
def	__repr__ (self)
	String representation of file data. More...
def	open (self, mode)
	Open this file in specified mode. More...
def	write (self, filename)
	Write XML representation to a file. More...
def	__eq__ (self, other)
	Test for equality of files. More...
def	__ne__ (self, other)
	Test for inequality of files. More...

Detailed Description

Class that contains metadata for a file.

Definition at line 103 of file file.py.

Constructor & Destructor Documentation

__init__()

def pscfpp.file.File.__init__	(		self,
			path = None,
			scan = 1
	)

Constructor.

Parameters

path	path to file
scan	bool flag to scan time and size

Reimplemented in pscfpp.file.Directory.

Definition at line 110 of file file.py.

References pscfpp.file.File.mtime, pscfpp.file.File.path, pscfpp.file.Directory.path, pscfpp.make.MakeMaker.path, pscfpp.file.File.scan, pscfpp.file.Directory.scan(), pscfpp.file.File.size, pscfpp.text.Record.size, Pscf::SolventDescriptor.size(), Pscf::Vertex.size(), Pscf::Basis< D >::Star.size, Pscf::SymmetryGroup< SpaceSymmetry< D > >.size(), Pscf::SymmetryGroup< Symmetry >.size(), Pscf::Homogeneous::Clump.size(), Pscf::Homogeneous::Molecule.size(), Pscf::Mesh< D >.size(), Util::MemoryCounter.size(), Util::ArrayStack< Data >.size(), Util::DSArray< Data >.size(), Util::FArray< Data, Capacity >.size(), Util::FArray< Util::FMatrix< double, D, D >, 6 >.size(), Util::FArray< Propagator, 2 >.size(), Util::FArray< Util::Average, Dimension *Dimension >.size(), Util::FArray< double, 6 >.size(), Util::FArray< Type, Capacity >.size(), Util::FArray< Rational, D >.size(), Util::FArray< Pscf::RealVec< D >, D >.size(), Util::FArray< Data, 2 >.size(), Util::FArray< Util::Average, Dimension *(Dimension+1)/2 >.size(), Util::FArray< int, 2 >.size(), Util::FPArray< Data, Capacity >.size(), Util::FSArray< bool, 6 >.size(), Util::FSArray< double, 6 >.size(), Util::FSArray< Data, Capacity >.size(), Util::FSArray< Type, Capacity >.size(), Util::GArray< Propagator const * >.size(), Util::GArray< Rational >.size(), Util::GArray< Pscf::Basis::Star >.size(), Util::GArray< Util::Pair< int > >.size(), Util::GArray< Propagator< D > const * >.size(), Util::GArray< TP const * >.size(), Util::GArray< Util::AutoCorrStage< Data, Product > * >.size(), Util::GArray< int >.size(), Util::GArray< double >.size(), Util::GArray< Data >.size(), Util::GridArray< Data >.size(), Util::GStack< Data >.size(), Util::List< Data >.size(), Util::PArray< Data >.size(), Util::RingBuffer< FieldCUDA >.size(), Util::RingBuffer< T >.size(), Util::RingBuffer< Data >.size(), Util::RingBuffer< DArray< double > >.size(), Util::SSet< Data, Capacity >.size(), Util::Manager< Data >.size(), and Util::Grid.size().

Member Function Documentation

__str__()

def pscfpp.file.File.__str__

(

self

)

String representation of file data.

Reimplemented in pscfpp.file.Directory.

Definition at line 120 of file file.py.

References pscfpp.file.File.path, pscfpp.file.Directory.path, and pscfpp.make.MakeMaker.path.

Referenced by pscfpp.field.Field.write(), pscfpp.output.Thermo.write(), and pscfpp.output.State.write().

__repr__()

def pscfpp.file.File.__repr__

(

self

)

String representation of file data.

Reimplemented in pscfpp.file.Directory.

Definition at line 126 of file file.py.

References pscfpp.file.File.mtime, pscfpp.file.File.path, pscfpp.file.Directory.path, pscfpp.make.MakeMaker.path, pscfpp.file.File.size, pscfpp.text.Record.size, Pscf::SolventDescriptor.size(), Pscf::Vertex.size(), Pscf::Basis< D >::Star.size, Pscf::SymmetryGroup< Symmetry >.size(), Pscf::SymmetryGroup< SpaceSymmetry< D > >.size(), Pscf::Homogeneous::Clump.size(), Pscf::Homogeneous::Molecule.size(), Pscf::Mesh< D >.size(), Util::MemoryCounter.size(), Util::ArrayStack< Data >.size(), Util::DSArray< Data >.size(), Util::FArray< Pscf::RealVec< D >, D >.size(), Util::FArray< double, 6 >.size(), Util::FArray< Type, Capacity >.size(), Util::FArray< Util::Average, Dimension *(Dimension+1)/2 >.size(), Util::FArray< int, 2 >.size(), Util::FArray< Rational, D >.size(), Util::FArray< Data, 2 >.size(), Util::FArray< Util::FMatrix< double, D, D >, 6 >.size(), Util::FArray< Propagator, 2 >.size(), Util::FArray< Util::Average, Dimension *Dimension >.size(), Util::FArray< Data, Capacity >.size(), Util::FPArray< Data, Capacity >.size(), Util::FSArray< Type, Capacity >.size(), Util::FSArray< double, 6 >.size(), Util::FSArray< Data, Capacity >.size(), Util::FSArray< bool, 6 >.size(), Util::GArray< Propagator< D > const * >.size(), Util::GArray< TP const * >.size(), Util::GArray< Data >.size(), Util::GArray< double >.size(), Util::GArray< Util::Pair< int > >.size(), Util::GArray< Propagator const * >.size(), Util::GArray< Rational >.size(), Util::GArray< Pscf::Basis::Star >.size(), Util::GArray< Util::AutoCorrStage< Data, Product > * >.size(), Util::GArray< int >.size(), Util::GridArray< Data >.size(), Util::GStack< Data >.size(), Util::List< Data >.size(), Util::PArray< Data >.size(), Util::RingBuffer< T >.size(), Util::RingBuffer< Data >.size(), Util::RingBuffer< DArray< double > >.size(), Util::RingBuffer< FieldCUDA >.size(), Util::SSet< Data, Capacity >.size(), Util::Manager< Data >.size(), and Util::Grid.size().

open()

def pscfpp.file.File.open	(		self,
			mode
	)

Open this file in specified mode.

Parameters

mode	mode for opening, e.g., 'w' or 'r'

Definition at line 146 of file file.py.

References pscfpp.file.File.open(), pscfpp.file.File.path, pscfpp.file.Directory.path, and pscfpp.make.MakeMaker.path.

Referenced by pscfpp.file.File.open(), pscfpp.file.File.write(), and pscfpp.file.Directory.write().

write()

def pscfpp.file.File.write	(		self,
			filename
	)

Write XML representation to a file.

Parameters

filename

name of output file

Reimplemented in pscfpp.file.Directory.

Definition at line 154 of file file.py.

References pscfpp.file.File.open(), pscfpp.file.File.xml(), and pscfpp.file.Directory.xml().

__eq__()

def pscfpp.file.File.__eq__	(		self,
			other
	)

Test for equality of files.

This function returns true if this and other are equivalent.

Parameters

other

file to which to compare this one.

Reimplemented in pscfpp.file.Directory.

Definition at line 166 of file file.py.

References pscfpp.file.File.path, pscfpp.file.Directory.path, pscfpp.make.MakeMaker.path, pscfpp.file.File.size, pscfpp.text.Record.size, Pscf::SolventDescriptor.size(), Pscf::Vertex.size(), Pscf::Basis< D >::Star.size, Pscf::SymmetryGroup< SpaceSymmetry< D > >.size(), Pscf::SymmetryGroup< Symmetry >.size(), Pscf::Homogeneous::Clump.size(), Pscf::Homogeneous::Molecule.size(), Pscf::Mesh< D >.size(), Util::MemoryCounter.size(), Util::ArrayStack< Data >.size(), Util::DSArray< Data >.size(), Util::FArray< Pscf::RealVec< D >, D >.size(), Util::FArray< Type, Capacity >.size(), Util::FArray< Util::Average, Dimension *(Dimension+1)/2 >.size(), Util::FArray< int, 2 >.size(), Util::FArray< Rational, D >.size(), Util::FArray< Data, 2 >.size(), Util::FArray< Util::FMatrix< double, D, D >, 6 >.size(), Util::FArray< Propagator, 2 >.size(), Util::FArray< Util::Average, Dimension *Dimension >.size(), Util::FArray< double, 6 >.size(), Util::FArray< Data, Capacity >.size(), Util::FPArray< Data, Capacity >.size(), Util::FSArray< Data, Capacity >.size(), Util::FSArray< bool, 6 >.size(), Util::FSArray< Type, Capacity >.size(), Util::FSArray< double, 6 >.size(), Util::GArray< double >.size(), Util::GArray< Propagator< D > const * >.size(), Util::GArray< int >.size(), Util::GArray< Util::AutoCorrStage< Data, Product > * >.size(), Util::GArray< TP const * >.size(), Util::GArray< Data >.size(), Util::GArray< Propagator const * >.size(), Util::GArray< Util::Pair< int > >.size(), Util::GArray< Rational >.size(), Util::GArray< Pscf::Basis::Star >.size(), Util::GridArray< Data >.size(), Util::GStack< Data >.size(), Util::List< Data >.size(), Util::PArray< Data >.size(), Util::RingBuffer< FieldCUDA >.size(), Util::RingBuffer< T >.size(), Util::RingBuffer< Data >.size(), Util::RingBuffer< DArray< double > >.size(), Util::SSet< Data, Capacity >.size(), Util::Manager< Data >.size(), and Util::Grid.size().

__ne__()

def pscfpp.file.File.__ne__	(		self,
			other
	)

Test for inequality of files.

This function returns true if this and other are in-equivalent.

Parameters

other

file to which to compare this one.

Reimplemented in pscfpp.file.Directory.

Definition at line 179 of file file.py.

---

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

• file.py