OpendTect  6.6
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
DataCharacteristics Class Reference

byte-level data characteristics of stored data. More...

Inheritance diagram for DataCharacteristics:
[legend]

Public Types

enum  Format { Ieee , Ibm }
 
enum  UserType {
  Auto =0 , SI8 , UI8 , SI16 ,
  UI16 , SI32 , UI32 , F32 ,
  F64 , SI64
}
 
- Public Types inherited from BinDataDesc
enum  ByteCount { N1 =1 , N2 =2 , N4 =4 , N8 =8 }
 

Public Member Functions

 DataCharacteristics (bool ii=false, bool is=true, ByteCount n=N4, Format f=Ieee, bool l=__islittle__)
 
 DataCharacteristics (const BinDataDesc &bd)
 
 DataCharacteristics (const char *s)
 
 DataCharacteristics (const double &)
 
 DataCharacteristics (const double *)
 
 DataCharacteristics (const float &)
 
 DataCharacteristics (const float *)
 
 DataCharacteristics (const int &)
 
 DataCharacteristics (const int *)
 
 DataCharacteristics (const od_int64 &)
 
 DataCharacteristics (const od_int64 *)
 
 DataCharacteristics (const short &)
 
 DataCharacteristics (const short *)
 
 DataCharacteristics (const signed char &)
 
 DataCharacteristics (const signed char *)
 
 DataCharacteristics (const unsigned char &)
 
 DataCharacteristics (const unsigned char *)
 
 DataCharacteristics (const unsigned int &)
 
 DataCharacteristics (const unsigned int *)
 
 DataCharacteristics (const unsigned short &)
 
 DataCharacteristics (const unsigned short *)
 
 DataCharacteristics (OD::DataRepType tp)
 
 DataCharacteristics (unsigned char c1, unsigned char c2)
 
 DataCharacteristics (UserType)
 
virtual void dump (unsigned char &, unsigned char &) const
 
double getLimitValue (bool max) const
 
bool isIeee () const
 
virtual int maxStringifiedSize () const
 
bool needSwap () const
 
bool operator!= (const DataCharacteristics &dc) const
 
DataCharacteristicsoperator= (const BinDataDesc &bd)
 
bool operator== (const DataCharacteristics &dc) const
 
void putUserType (IOPar &iop) const
 
virtual void set (const char *)
 
virtual void set (unsigned char, unsigned char)
 
virtual void toString (BufferString &) const
 
UserType userType () const
 will return 'nearest' More...
 
- Public Member Functions inherited from BinDataDesc
 BinDataDesc (bool ii, bool is, int b)
 
 BinDataDesc (bool ii=false, bool is=true, ByteCount b=N4)
 
 BinDataDesc (const char *s)
 
 BinDataDesc (const double &)
 
 BinDataDesc (const double *)
 
 BinDataDesc (const float &)
 
 BinDataDesc (const float *)
 
 BinDataDesc (const int &)
 
 BinDataDesc (const int *)
 
 BinDataDesc (const short &)
 
 BinDataDesc (const short *)
 
 BinDataDesc (const signed char &)
 
 BinDataDesc (const signed char *)
 
 BinDataDesc (const unsigned char &)
 
 BinDataDesc (const unsigned char *)
 
 BinDataDesc (const unsigned int &)
 
 BinDataDesc (const unsigned int *)
 
 BinDataDesc (const unsigned short &)
 
 BinDataDesc (const unsigned short *)
 
 BinDataDesc (unsigned char c1, unsigned char c2)
 
virtual ~BinDataDesc ()
 
virtual bool convertsWellTo (const BinDataDesc &) const
 
bool isEqual (const BinDataDesc &dc) const
 
bool isInteger () const
 
bool isSigned () const
 
ByteCount nrBytes () const
 
bool operator!= (const BinDataDesc &dc) const
 
bool operator== (const BinDataDesc &dc) const
 
void set (bool ii, bool is, ByteCount b)
 
void set (bool ii, bool is, int b)
 
void setInteger (bool yn)
 
void setNrBytes (ByteCount n)
 
void setNrBytes (int n)
 
void setSigned (bool yn)
 
int sizeFor (int n) const
 

Static Public Member Functions

static bool getUserTypeFromPar (const IOPar &, UserType &)
 
static void putUserTypeToPar (IOPar &, UserType)
 
- Static Public Member Functions inherited from BinDataDesc
static ByteCount nearestByteCount (bool is_int, int s)
 
static int nextSize (bool is_int, int s)
 

Public Attributes

Format fmt_
 
bool littleendian_
 

Additional Inherited Members

- Protected Member Functions inherited from BinDataDesc
void setFrom (unsigned char, bool)
 
- Protected Attributes inherited from BinDataDesc
bool isint_
 
bool issigned_
 
ByteCount nrbytes_
 

Detailed Description

byte-level data characteristics of stored data.

Used for the interpretation (read or write) of data in buffers that are read directly from disk into buffer. In that case cross-platform issues arise: byte-ordering and int/float layout. The IBM Format is only supported for the types that are used in SEG-Y sample data handling. SGI is a future option.

<>

Member Enumeration Documentation

◆ Format

Enumerator
Ieee 
Ibm 

◆ UserType

Enumerator
Auto 
SI8 
UI8 
SI16 
UI16 
SI32 
UI32 
F32 
F64 
SI64 

Constructor & Destructor Documentation

◆ DataCharacteristics() [1/24]

DataCharacteristics::DataCharacteristics ( bool  ii = false,
bool  is = true,
ByteCount  n = N4,
Format  f = Ieee,
bool  l = __islittle__ 
)
inline

◆ DataCharacteristics() [2/24]

DataCharacteristics::DataCharacteristics ( const BinDataDesc bd)
inline

◆ DataCharacteristics() [3/24]

DataCharacteristics::DataCharacteristics ( unsigned char  c1,
unsigned char  c2 
)
inline

◆ DataCharacteristics() [4/24]

DataCharacteristics::DataCharacteristics ( const char *  s)
inline

◆ DataCharacteristics() [5/24]

DataCharacteristics::DataCharacteristics ( const signed char *  )
inline

◆ DataCharacteristics() [6/24]

DataCharacteristics::DataCharacteristics ( const signed char &  )
inline

◆ DataCharacteristics() [7/24]

DataCharacteristics::DataCharacteristics ( const short *  )
inline

◆ DataCharacteristics() [8/24]

DataCharacteristics::DataCharacteristics ( const short &  )
inline

◆ DataCharacteristics() [9/24]

DataCharacteristics::DataCharacteristics ( const int *  )
inline

◆ DataCharacteristics() [10/24]

DataCharacteristics::DataCharacteristics ( const int &  )
inline

◆ DataCharacteristics() [11/24]

DataCharacteristics::DataCharacteristics ( const unsigned char *  )
inline

◆ DataCharacteristics() [12/24]

DataCharacteristics::DataCharacteristics ( const unsigned char &  )
inline

◆ DataCharacteristics() [13/24]

DataCharacteristics::DataCharacteristics ( const unsigned short *  )
inline

◆ DataCharacteristics() [14/24]

DataCharacteristics::DataCharacteristics ( const unsigned short &  )
inline

◆ DataCharacteristics() [15/24]

DataCharacteristics::DataCharacteristics ( const unsigned int *  )
inline

◆ DataCharacteristics() [16/24]

DataCharacteristics::DataCharacteristics ( const unsigned int &  )
inline

◆ DataCharacteristics() [17/24]

DataCharacteristics::DataCharacteristics ( const float *  )
inline

◆ DataCharacteristics() [18/24]

DataCharacteristics::DataCharacteristics ( const float &  )
inline

◆ DataCharacteristics() [19/24]

DataCharacteristics::DataCharacteristics ( const double *  )
inline

◆ DataCharacteristics() [20/24]

DataCharacteristics::DataCharacteristics ( const double &  )
inline

◆ DataCharacteristics() [21/24]

DataCharacteristics::DataCharacteristics ( const od_int64 *  )
inline

◆ DataCharacteristics() [22/24]

DataCharacteristics::DataCharacteristics ( const od_int64 &  )
inline

◆ DataCharacteristics() [23/24]

DataCharacteristics::DataCharacteristics ( UserType  )

◆ DataCharacteristics() [24/24]

DataCharacteristics::DataCharacteristics ( OD::DataRepType  tp)
inline

Member Function Documentation

◆ dump()

virtual void DataCharacteristics::dump ( unsigned char &  ,
unsigned char &   
) const
virtual

Reimplemented from BinDataDesc.

◆ getLimitValue()

double DataCharacteristics::getLimitValue ( bool  max) const

◆ getUserTypeFromPar()

static bool DataCharacteristics::getUserTypeFromPar ( const IOPar ,
UserType  
)
static

◆ isIeee()

bool DataCharacteristics::isIeee ( ) const
inline

◆ maxStringifiedSize()

virtual int DataCharacteristics::maxStringifiedSize ( ) const
inlinevirtual

Reimplemented from BinDataDesc.

◆ needSwap()

bool DataCharacteristics::needSwap ( ) const
inline

◆ operator!=()

bool DataCharacteristics::operator!= ( const DataCharacteristics dc) const
inline

◆ operator=()

DataCharacteristics& DataCharacteristics::operator= ( const BinDataDesc bd)
inline

◆ operator==()

bool DataCharacteristics::operator== ( const DataCharacteristics dc) const
inline

◆ putUserType()

void DataCharacteristics::putUserType ( IOPar iop) const
inline

◆ putUserTypeToPar()

static void DataCharacteristics::putUserTypeToPar ( IOPar ,
UserType   
)
static

◆ set() [1/2]

virtual void DataCharacteristics::set ( const char *  )
virtual

Reimplemented from BinDataDesc.

◆ set() [2/2]

virtual void DataCharacteristics::set ( unsigned char  ,
unsigned char   
)
virtual

Reimplemented from BinDataDesc.

◆ toString()

virtual void DataCharacteristics::toString ( BufferString ) const
virtual

Reimplemented from BinDataDesc.

◆ userType()

UserType DataCharacteristics::userType ( ) const

will return 'nearest'

Member Data Documentation

◆ fmt_

Format DataCharacteristics::fmt_

◆ littleendian_

bool DataCharacteristics::littleendian_

Generated at for the OpendTect seismic interpretation project. Copyright (C): dGB Beheer B.V. 1995-2022