OpendTect  6.6
Public Types | Public Member Functions | Protected Attributes | Private Member Functions | List of all members
ascistream Class Reference

OpendTect standard ascii format file reading. More...

Public Types

enum  EntryType {
  Empty , Keyword , KeyVal , ParagraphMark ,
  EndOfFile
}
 

Public Member Functions

 ascistream (od_istream &, bool rdhead=true)
 
 ascistream (od_istream *, bool rdhead=true)
 
virtual ~ascistream ()
 
bool atEOS () const
 returns true if at end of segment (='paragraph') More...
 
const char * fileType () const
 
double getDValue (int i=0) const
 
float getFValue (int i=0) const
 
int64_t getI64Value (int i=0) const
 
int getIValue (int i=0) const
 
uint64_t getUI64Value (int i=0) const
 
unsigned int getUIValue (int i=0) const
 
bool getYN (int i=0) const
 
bool hasKeyword (const char *) const
 
bool hasStandardHeader () const
 
bool hasValue (const char *) const
 
const char * headerStartLine () const
 
bool isOfFileType (const char *) const
 
bool isOK () const
 
const char * keyWord () const
 
int majorVersion () const
 
int minorVersion () const
 
ascistreamnext ()
 
int patchVersion () const
 
void setKeyWord (const char *s)
 
void setValue (const char *s)
 
od_istreamstream ()
 
const char * timeStamp () const
 
EntryType type () const
 
const char * value () const
 
const char * version () const
 

Protected Attributes

BufferString filetype_
 
BufferString header_
 
BufferString keybuf_
 
od_istreamstrm_
 
bool strmmine_
 
BufferString timestamp_
 
BufferString valbuf_
 

Private Member Functions

void init (bool)
 

Detailed Description

OpendTect standard ascii format file reading.

An ascistream gets data from a OpendTect standard ascii format file. This format consists of the OpendTect header (version, file type, date), and then a number of 'paragraphs', each separated by a single '!' on a line.

<>

Member Enumeration Documentation

◆ EntryType

Enumerator
Empty 
Keyword 
KeyVal 
ParagraphMark 
EndOfFile 

Constructor & Destructor Documentation

◆ ascistream() [1/2]

ascistream::ascistream ( od_istream ,
bool  rdhead = true 
)

◆ ascistream() [2/2]

ascistream::ascistream ( od_istream ,
bool  rdhead = true 
)

◆ ~ascistream()

virtual ascistream::~ascistream ( )
virtual

Member Function Documentation

◆ atEOS()

bool ascistream::atEOS ( ) const
inline

returns true if at end of segment (='paragraph')

◆ fileType()

const char* ascistream::fileType ( ) const
inline

◆ getDValue()

double ascistream::getDValue ( int  i = 0) const

◆ getFValue()

float ascistream::getFValue ( int  i = 0) const

◆ getI64Value()

int64_t ascistream::getI64Value ( int  i = 0) const

◆ getIValue()

int ascistream::getIValue ( int  i = 0) const

◆ getUI64Value()

uint64_t ascistream::getUI64Value ( int  i = 0) const

◆ getUIValue()

unsigned int ascistream::getUIValue ( int  i = 0) const

◆ getYN()

bool ascistream::getYN ( int  i = 0) const

◆ hasKeyword()

bool ascistream::hasKeyword ( const char *  ) const

◆ hasStandardHeader()

bool ascistream::hasStandardHeader ( ) const

◆ hasValue()

bool ascistream::hasValue ( const char *  ) const

◆ headerStartLine()

const char* ascistream::headerStartLine ( ) const
inline

◆ init()

void ascistream::init ( bool  )
private

◆ isOfFileType()

bool ascistream::isOfFileType ( const char *  ) const

◆ isOK()

bool ascistream::isOK ( ) const

◆ keyWord()

const char* ascistream::keyWord ( ) const
inline

◆ majorVersion()

int ascistream::majorVersion ( ) const

◆ minorVersion()

int ascistream::minorVersion ( ) const

◆ next()

ascistream& ascistream::next ( )

◆ patchVersion()

int ascistream::patchVersion ( ) const

◆ setKeyWord()

void ascistream::setKeyWord ( const char *  s)
inline

◆ setValue()

void ascistream::setValue ( const char *  s)
inline

◆ stream()

od_istream& ascistream::stream ( )
inline

◆ timeStamp()

const char* ascistream::timeStamp ( ) const
inline

◆ type()

EntryType ascistream::type ( ) const

◆ value()

const char* ascistream::value ( ) const
inline

◆ version()

const char* ascistream::version ( ) const

Member Data Documentation

◆ filetype_

BufferString ascistream::filetype_
protected

◆ header_

BufferString ascistream::header_
protected

◆ keybuf_

BufferString ascistream::keybuf_
protected

◆ strm_

od_istream& ascistream::strm_
protected

◆ strmmine_

bool ascistream::strmmine_
protected

◆ timestamp_

BufferString ascistream::timestamp_
protected

◆ valbuf_

BufferString ascistream::valbuf_
protected

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