UNIVERS  15.3
UNIVERS base processing software API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros
Public Member Functions | Public Attributes | List of all members
ZTracePar Class Reference

#include <ZTracePar.H>

Public Member Functions

 ZTracePar (unsigned samples, float dt_=1.0, float t0_=0.0, const unsigned actual_[2]=NULL)
 
 ZTracePar (const ZTracePar &trpar)
 
void assign (unsigned samples, float dt_=1.0, float t0_=0.0, const unsigned actual_[2]=NULL)
 
void all_actual ()
 
int time2sample (float t) const
 
float sample2time (int i) const
 
int operator== (const ZTracePar &trpar) const
 
int operator!= (const ZTracePar &trpar) const
 
void print_self (FILE *fp=NULL) const
 

Public Attributes

unsigned samples
 
unsigned actual [2]
 
float dt
 
float t0
 

Detailed Description

Minimal trace description structure.

Constructor & Destructor Documentation

ZTracePar::ZTracePar ( unsigned  samples,
float  dt_ = 1.0,
float  t0_ = 0.0,
const unsigned  actual_[2] = NULL 
)

Create trace parameters from exact numbers.

ZTracePar::ZTracePar ( const ZTracePar trpar)

Create trace parameters as a copy of some object.

Member Function Documentation

void ZTracePar::all_actual ( )

Make the whole range to be actual.

void ZTracePar::assign ( unsigned  samples,
float  dt_ = 1.0,
float  t0_ = 0.0,
const unsigned  actual_[2] = NULL 
)

Assign new values with checking them.

int ZTracePar::operator== ( const ZTracePar trpar) const

Check for equal number of samples, dt and t0.

void ZTracePar::print_self ( FILE *  fp = NULL) const

Print self to the given file or to wePutMsg by default.

float ZTracePar::sample2time ( int  i) const

Convert sample index to time.

int ZTracePar::time2sample ( float  t) const

Convert time to sample index.

Member Data Documentation

unsigned ZTracePar::actual[2]

actual range of samples

float ZTracePar::dt

sampling rate, ms

unsigned ZTracePar::samples

number of samples

float ZTracePar::t0

time of the first sample, ms


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