SEGY::HdrEntry Class Reference

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

#include <segyhdrdef.h>

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

Public Member Functions
	HdrEntry (const char *desc, const char *nm, BytePos bp=udfBP(), bool issmall=false, DataType dt=SInt)
	HdrEntry (const HdrEntry &oth)
	~HdrEntry ()
int	byteSize () const
const char *	description () const
void	fillPar (IOPar &, const char *ky) const
int	getValue (const void *buf, bool swapped=false) const
bool	isInternal () const
bool	isUdf () const
const char *	name () const
HdrEntry &	operator= (const HdrEntry &)
void	putValue (void *buf, int) const
void	removeFromPar (IOPar &, const char *ky) const
void	setDescription (const char *)
void	setName (const char *)
void	setUdf ()
void	usePar (const IOPar &, const char *ky, const HdrDef *=nullptr)
bool	usesByte (BytePos b) 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

BytePos

typedef short SEGY::HdrEntry::BytePos

Member Enumeration Documentation

DataType

enum SEGY::HdrEntry::DataType

Enumerator
SInt
UInt
Float

Constructor & Destructor Documentation

HdrEntry() [1/2]

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

HdrEntry() [2/2]

SEGY::HdrEntry::HdrEntry

(

const HdrEntry &

oth

)

~HdrEntry()

SEGY::HdrEntry::~HdrEntry

(

)

Member Function Documentation

byteSize()

int SEGY::HdrEntry::byteSize ( ) const

inline

description()

const char * SEGY::HdrEntry::description

(

)

const

fillPar()

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

getValue()

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

isInternal()

bool SEGY::HdrEntry::isInternal ( ) const

inline

isUdf()

bool SEGY::HdrEntry::isUdf ( ) const

inline

name()

const char * SEGY::HdrEntry::name

(

)

const

operator=()

HdrEntry & SEGY::HdrEntry::operator=

(

const HdrEntry &

)

putValue()

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

removeFromPar()

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

setDescription()

void SEGY::HdrEntry::setDescription

(

const char *

)

setName()

void SEGY::HdrEntry::setName

(

const char *

)

setUdf()

void SEGY::HdrEntry::setUdf ( )

inline

udfBP()

static BytePos SEGY::HdrEntry::udfBP ( )

inlinestaticprotected

usePar()

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

usesByte()

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

inline

Member Data Documentation

bytepos_

BytePos SEGY::HdrEntry::bytepos_

desc_

BufferString SEGY::HdrEntry::desc_

protected

issmall_

bool SEGY::HdrEntry::issmall_

name_

BufferString SEGY::HdrEntry::name_

protected

type_

DataType SEGY::HdrEntry::type_