class DiagDataDescriptor : public ligogui BasicDataDescriptor

Object for describing diagnostics data

Inheritance:

Public Methods

	DiagDataDescriptor (diag::basic_commandline* cmd, const TString& name, Int_t length, Int_t offsetX, Int_t offsetY, Bool_t cmplx = kFALSE, Bool_t cpyOnNeed = kTRUE, Bool_t eliminateZeros = kFALSE) Constructor.
	DiagDataDescriptor (diag::basic_commandline* cmd, const TString& name, Int_t length, Double_t x0, Double_t dx, Int_t offsetY = 0, Bool_t cmplx = kFALSE, Bool_t cpyOnNeed = kTRUE, Bool_t eliminateZeros = kFALSE) Constructor.
	DiagDataDescriptor (diag::basic_commandline* cmd, const TString& name, Bool_t cmplx, Int_t length, Int_t tablewidth, Int_t tablecol, Bool_t cpyOnNeed = kTRUE) Constructor.
	DiagDataDescriptor (diag::basic_commandline* cmd, const TString& name, Bool_t cmplx, Int_t length, Int_t tablewidth, Int_t tablecol, Double_t x0, Double_t dx, Bool_t cpyOnNeed = kTRUE) Constructor.
virtual	~DiagDataDescriptor () Destructor.
virtual Bool_t	IsXY () const Is XY.
virtual Float_t	GetDX () const x spacing.
virtual Int_t	GetN () const Get N method.
virtual Float_t*	GetX () const Get X method.
virtual Float_t*	GetY () const Get Y method.
virtual Bool_t	EraseData () Erase data method.

Protected Fields

diag::basic_commandline*	fCmdLine Pointer to commad line object
TString	fName Name of data object
Bool_t	fXYData XY or just Y with x0 and dx
Double_t	fDX dx
Int_t	fOffsetX X offset into data object
Int_t	fOffsetY Y offset into data object
Int_t	fLength Length of original data array
Bool_t	fTableData Data stored in a table?
Int_t	fTableWidth Table width
Int_t	fTableCol Table column
Bool_t	fNoZero Eliminate zeros?
mutable Int_t	fN Length of data set
mutable Float_t*	fX X array
mutable Float_t*	fY Y array
mutable Float_t*	fTable table

Protected Methods

virtual Bool_t

GetData () const Get data method.

diag::basic_commandline* fCmdLine

Pointer to commad line object

TString fName

Name of data object

Bool_t fXYData

XY or just Y with x0 and dx

Double_t fDX

dx

Int_t fOffsetX

X offset into data object

Int_t fOffsetY

Y offset into data object

Int_t fLength

Length of original data array

Bool_t fTableData

Data stored in a table?

Int_t fTableWidth

Table width

Int_t fTableCol

Table column

Bool_t fNoZero

Eliminate zeros?

mutable Int_t fN

Length of data set

mutable Float_t* fX

X array

mutable Float_t* fY

Y array

mutable Float_t* fTable

table

virtual Bool_t GetData() const

Gets the data from the diagnostics kernel.

Returns:

true if successful

DiagDataDescriptor(diag::basic_commandline* cmd, const TString& name, Int_t length, Int_t offsetX, Int_t offsetY, Bool_t cmplx = kFALSE, Bool_t cpyOnNeed = kTRUE, Bool_t eliminateZeros = kFALSE)

Constructs a diagnostics data descriptor. The convention for complex data arrays is to store real and imaginary part of each value in the array as two consequitive numbers.

Returns:

void

Parameters:

cmd - Pointer to command line interface
name - Name of data object
length - Length of data
offsetX - X array offset into data object
offsetY - Y array offset into data object
cmplx - if kTRUE Y array is complex
cpyOnNeed - Copy data from kernel when needed
eliminateZeros - If true (0,0) data points are automatically eliminated from the data set

DiagDataDescriptor(diag::basic_commandline* cmd, const TString& name, Int_t length, Double_t x0, Double_t dx, Int_t offsetY = 0, Bool_t cmplx = kFALSE, Bool_t cpyOnNeed = kTRUE, Bool_t eliminateZeros = kFALSE)

Constructs a diagnostics data descriptor. The convention for complex data arrays is to store real and imaginary part of each value in the array as two consequitive numbers.

Returns:

void

Parameters:

cmd - Pointer to command line interface
name - Name of data object
length - Length of data
x0 - X start
dx - X spacing
offsetY - Y array offset into data object
cmplx - if kTRUE Y array is complex
cpyOnNeed - Copy data from kernel when needed
eliminateZeros - If true (0,0) data points are automatically eliminated from the data set

DiagDataDescriptor(diag::basic_commandline* cmd, const TString& name, Bool_t cmplx, Int_t length, Int_t tablewidth, Int_t tablecol, Bool_t cpyOnNeed = kTRUE)

Constructs a diagnostics data descriptor. The convention for complex data arrays is to store real and imaginary part of each value in the array as two numbers. This constructor assumes the data is stored in a table of coefficients where echa row represents a different ferquency.

Returns:

void

Parameters:

cmd - Pointer to command line interface
name - Name of data object
cmplx - if kTRUE Y array is complex
length - Length of data
tablewidth - Width of table
tablecol - Column number in table
cpyOnNeed - Copy data from kernel when needed

DiagDataDescriptor(diag::basic_commandline* cmd, const TString& name, Bool_t cmplx, Int_t length, Int_t tablewidth, Int_t tablecol, Double_t x0, Double_t dx, Bool_t cpyOnNeed = kTRUE)

Constructs a diagnostics data descriptor. The convention for complex data arrays is to store real and imaginary part of each value in the array as two numbers. This constructor assumes the data is stored in a table of coefficients where echa row represents a different ferquency.

Returns:

void

Parameters:

cmd - Pointer to command line interface
name - Name of data object
cmplx - if kTRUE Y array is complex
length - Length of data
tablewidth - Width of table
tablecol - Column number in table
x0 - X start
dx - X spacing
cpyOnNeed - Copy data from kernel when needed

virtual ~DiagDataDescriptor()

Destructs a diagnostics data descriptor.

Returns:

void

virtual Bool_t IsXY() const

Returns true if xy data.

Returns:

true if xy

virtual Float_t GetDX() const

Returns x spacing if xy data.

Returns:

x spacing

virtual Int_t GetN() const

Returns a the length of the data array.

Returns:

Length

virtual Float_t* GetX() const

Returns a pointer to the X data array.

Returns:

X array

virtual Float_t* GetY() const

Returns a pointer to the Y data array.

Returns:

Y array

virtual Bool_t EraseData()

Erases the local data.

Returns:

true if successful

alphabetic index hierarchy of classes

Please send questions and comments to sigg_d@ligo-wa.caltech.edu

generated by doc++