TSOpt::SEGYDCF Class Reference

DC Factory methods for OC classes must depend only on initialization of the prototype filename string. More...

#include <segypp.hh>

List of all members.

Public Member Functions
	SEGYDCF (string _hdr, ostream &_outfile=cerr)
	bare constructor - does not initialize
	SEGYDCF (SEGYDCF const &f)
	bare copy constructor - does not initialize
	~SEGYDCF ()
SEGYDCF *	cloneSEGY () const
	bare clone method - does not initialize
PackageContainerFactory< float, segy > *	clone () const
string	getFilename () const
	return header file name
float	getDt () const
	return time step for scaling l2 inner product - initialization required
int	getNt () const
	return number of time samples - initialization required
int	getNB () const
	return number of bytes per trace - initialization required
bool	compare (DataContainerFactory const &dcf) const
	bare compare method - needs only hdr filename
bool	isCompatible (DataContainer const &dc) const
	bare compatibility method - needs only hdr filename
ostream &	write (ostream &str) const
	bare write method - needs only hdr filename
Protected Member Functions
SEGYDC *	buildSEGY () const
	must initialize before invoking SEGYDC constr - registers hdr with file mgmt
PackageContainer< float, segy > *	buildPC () const

---

Detailed Description

DC Factory methods for OC classes must depend only on initialization of the prototype filename string.

All other class methods should be limited to rank 0 in parallel execution, and DCF methods should not depend on them. This feature should probably be abstracted in a superclass.

Definition at line 171 of file segypp.hh.

---

Constructor & Destructor Documentation

TSOpt::SEGYDCF::SEGYDCF	(	string	_hdr,
		ostream &	_outfile = cerr
	)

bare constructor - does not initialize

TSOpt::SEGYDCF::SEGYDCF

(

SEGYDCF const &

f

)

bare copy constructor - does not initialize

Definition at line 206 of file segypp.hh.

TSOpt::SEGYDCF::~SEGYDCF

(

)

Definition at line 209 of file segypp.hh.

---

Member Function Documentation

SEGYDC* TSOpt::SEGYDCF::buildSEGY

(

)

const [protected]

must initialize before invoking SEGYDC constr - registers hdr with file mgmt

Definition at line 192 of file segypp.hh.

Referenced by buildPC().

PackageContainer<float,segy>* TSOpt::SEGYDCF::buildPC

(

)

const [protected]

Definition at line 196 of file segypp.hh.

References buildSEGY().

SEGYDCF* TSOpt::SEGYDCF::cloneSEGY

(

)

const

bare clone method - does not initialize

Definition at line 212 of file segypp.hh.

Referenced by clone().

PackageContainerFactory<float,segy>* TSOpt::SEGYDCF::clone

(

)

const

Definition at line 216 of file segypp.hh.

References cloneSEGY().

string TSOpt::SEGYDCF::getFilename

(

)

const

return header file name

Definition at line 221 of file segypp.hh.

Referenced by TSOpt::SEGYSpace::getPrototypeFilename(), and TSOpt::MPISEGYSpace::getPrototypeFilename().

float TSOpt::SEGYDCF::getDt

(

)

const

return time step for scaling l2 inner product - initialization required

Definition at line 225 of file segypp.hh.

Referenced by TSOpt::SEGYSpace::getDt(), TSOpt::MPISEGYSpace::getDt(), and TSOpt::MPISEGYSpace::MPISEGYSpace().

int TSOpt::SEGYDCF::getNt

(

)

const

return number of time samples - initialization required

Definition at line 228 of file segypp.hh.

Referenced by TSOpt::SEGYSpace::getNt(), and TSOpt::MPISEGYSpace::getNt().

int TSOpt::SEGYDCF::getNB

(

)

const

return number of bytes per trace - initialization required

Definition at line 231 of file segypp.hh.

bool TSOpt::SEGYDCF::compare

(

DataContainerFactory const &

dcf

)

const

bare compare method - needs only hdr filename

bool TSOpt::SEGYDCF::isCompatible

(

DataContainer const &

dc

)

const

bare compatibility method - needs only hdr filename

ostream& TSOpt::SEGYDCF::write

(

ostream &

str

)

const

bare write method - needs only hdr filename

---

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

• segypp.hh

---