SEGY::HdrEntry Class Reference

describes one tape or trace header field, More...

Public Types
enum	DataType { SInt, UInt, Float }
typedef short	BytePos

Public Member Functions
	HdrEntry (const char *desc, const char *nm, BytePos bp=udfBP(), bool issmall=false, DataType dt=SInt)
	HdrEntry (const HdrEntry &he)
HdrEntry &	operator= (const HdrEntry &)
const char *	description () const
void	setDescription (const char *)
const char *	name () const
void	setName (const char *)
bool	isInternal () const
int	byteSize () const
bool	isUdf () const
void	setUdf ()
bool	usesByte (BytePos b) const
int	getValue (const void *buf, bool swapped=false) const
void	putValue (void *buf, int) const
void	usePar (const IOPar &, const char *ky, const HdrDef *hd=0)
void	fillPar (IOPar &, const char *ky) const
void	removeFromPar (IOPar &, const char *ky) const

Public Attributes
BytePos	bytepos_
bool	issmall_
DataType	type_

Static Protected Member Functions
static BytePos	udfBP ()

Protected Attributes
BufferString	desc_
BufferString	name_

Detailed Description

describes one tape or trace header field,

Note: it is important to know whether your HdrEntry is in 'internal' or in 'user' format. The difference is 1 byte. For example, tracr is at byte 4 of the trace header, but users need to see 5. The reasone we don't always use internal entries is that some things have to be directly stored in user settings.

Member Typedef Documentation

typedef short SEGY::HdrEntry::BytePos

Member Enumeration Documentation

enum SEGY::HdrEntry::DataType

Enumerator
SInt
UInt
Float

Constructor & Destructor Documentation

SEGY::HdrEntry::HdrEntry ( const char *  desc, const char *  nm, BytePos  bp = udfBP(), bool  issmall = false, DataType  dt = SInt  )

inline

SEGY::HdrEntry::HdrEntry ( const HdrEntry &  he )

inline

Member Function Documentation

int SEGY::HdrEntry::byteSize ( ) const

inline

const char* SEGY::HdrEntry::description

(

)

const

void SEGY::HdrEntry::fillPar	(	IOPar &	,
		const char *	ky
	)		const

int SEGY::HdrEntry::getValue	(	const void *	buf,
		bool	swapped = false
	)		const

bool SEGY::HdrEntry::isInternal ( ) const

inline

bool SEGY::HdrEntry::isUdf ( ) const

inline

const char* SEGY::HdrEntry::name

(

)

const

HdrEntry& SEGY::HdrEntry::operator=

(

const HdrEntry &

)

void SEGY::HdrEntry::putValue	(	void *	buf,
		int
	)		const

void SEGY::HdrEntry::removeFromPar	(	IOPar &	,
		const char *	ky
	)		const

void SEGY::HdrEntry::setDescription

(

const char *

)

void SEGY::HdrEntry::setName

(

const char *

)

void SEGY::HdrEntry::setUdf ( )

inline

static BytePos SEGY::HdrEntry::udfBP ( )

inlinestaticprotected

void SEGY::HdrEntry::usePar	(	const IOPar &	,
		const char *	ky,
		const HdrDef *	hd = 0
	)

bool SEGY::HdrEntry::usesByte ( BytePos  b ) const

inline

Member Data Documentation

BytePos SEGY::HdrEntry::bytepos_

BufferString SEGY::HdrEntry::desc_

protected

bool SEGY::HdrEntry::issmall_

BufferString SEGY::HdrEntry::name_

protected

DataType SEGY::HdrEntry::type_