QSAS_2_4/QSAS_dist/src/Utilities/qdutil/qdutil.h File Reference

#include <stdlib.h>
#include <QMainWindow>
#include "Qdos.h"
#include "Xrefs.h"
#include "qprofile.h"
#include <qcolordialog.h>
#include <qcheckbox.h>
#include <QDomDocument>

Namespaces
namespace	QSAS
Defines
#define	REMOVE_GAP   "remove gaps"
#define	ZERO_FILL_GAP   "zero-fill"
#define	FILL_GAP   "fill value"
#define	LINEAR_INTERP_GAP   "linear interpolation"
#define	NEAREST_NEIGHBOUR_GAP   "nearest neighbour"
#define	NEW_NAME   "new name"
#define	QDUTIL_OK   0
#define	QDUTIL_ERR   1
#define	QDUTIL_WARN   2
#define	EVENT_0_STR   " < 0 >"
#define	R_STR_CMP   " [ r (mag) ]"
#define	X_STR_CMP   " [ x ]"
#define	Y_STR_CMP   " [ y ]"
#define	Z_STR_CMP   " [ z ]"
#define	Ld_STR_CMP   " [ Lat (deg) ]"
#define	Lr_STR_CMP   " [ Lat (rad) ]"
#define	Td_STR_CMP   " [ theta (deg) ]"
#define	Tr_STR_CMP   " [ theta (rad) ]"
#define	Pd_STR_CMP   " [ phi (deg) ]"
#define	Pr_STR_CMP   " [ phi (rad) ]"
#define	T_STR_START   " [ Start Time ]"
#define	T_STR_CENTRE   " [ Centre Time ]"
#define	T_STR_END   " [ End Time ]"
Typedefs
typedef vector< int >	dimTriple
typedef vector< dimTriple >	dimTripleStack
typedef enum QguComp_e	QguComp
Enumerations
enum	QguComp_e {   UNKNOWN_COMP = -1, WL_OBJ = 0, R_COMP = 1, X_COMP = 2,   Y_COMP = 3, Z_COMP = 4, LAT_DEG_COMP = 5, THETA_DEG_COMP = 6,   PHI_DEG_COMP = 7, LAT_RAD_COMP = 8, THETA_RAD_COMP = 9, PHI_RAD_COMP = 10,   ARRAY_COMP = 11, XREF_COMP = 12, T_START_COMP = 13, T_CENTRE_COMP = 14,   T_END_COMP = 15, XREF_OBJ = 16, SLICE_COMP = 17 }
Functions
void	QSAS::QuMultiJoin (QdObjectSeq_var join_obj_seq, QdTimeSeq_var join_pts, QdObjectSeq_var joined_obj_seq, vector< KVDataBase_var > options, int triage_cnt=-1)
void	QSAS::QuMultiJoinXrefs (QdObject_var preJoinObj, QdObject_var joinedObj, QdObject_var joinMethod, double gap)
QDomElement	createTextXMLNode (QDomDocument &doc, const QString &parentName, const QString &)
QDomElement	createTextXMLNode (QDomDocument &doc, const QString &parentName, const std::string &)
QDomElement	createTextXMLNode (QDomDocument &doc, const QString &parentName, const char *)
QDomElement	createTextXMLNode (QDomDocument &doc, const QString &parentName, const double)
QDomElement	createTextXMLNode (QDomDocument &doc, const QString &parentName, const int)
QDomElement	createTextXMLNode (QDomDocument &doc, const QString &parentName, const bool)
bool	getXMLNodeText (QDomElement &el, const QString &tag, QString &val)
char *	QuNewSTR (const char *in_str)
int	QuAreUnitsSame (QdObject_var ptr1, QdObject_var ptr2)
int	QuAreFramesSame (QdObject_var ptr1, QdObject_var ptr2)
QString	encode (const QString &input)
QString	decode (const QString &input)
QString	QuGetDefaultComp (const QString &WL, const QString &compDef)
void	QuReplaceTokens (QString &newTxt, QString &oldTxt)
bool	QuIsMatch (double value, double fill)
QCheckBox *	checkBadData (QWidget *parent=0)
QCheckBox *	checkFills (QWidget *parent=0)
bool	QuSlotDebug ()
string	QuCommonLabl (string str1, string str2)
QdObject_var	QuGetObjByName (const QString &name)
QdObject_var	QuTakeSlice (vector< string > objectNameList, QdObject_var dobj, dimTriple sliceTriple, bool getInterval)
QdObject_var	QuGetSubset (QdObject_var dobj, int recStart, int recEnd)
QString	baseObjectText (QString)
QguComp	compEntry (const char *, const char *)
	Method that returns the component entry in the dropdown box from the type of component and the component text.
QguComp	compEntry (const char *)
	Method that returns the component entry in the dropdown box from the component text.
QString	compText (QString)
QString	compText (QString, const dimTriple &)
QString	getXrefName (QString)
	Method that returns the xref name from the text in the input slot.
dimTriple	getDimTriple (QString &compTxt)
	Method that parses text in QguLineEdit and finds the array reduction requested.
dimTriple	getSliceTriple (const QString &compTxt)
dimTripleStack	getDimTripleStack (QString &compTxt)
	Method that parses text in QguLineEdit and finds the array reduction requested.
QdObject_var	QuGetObjByNameAndComp (const QString &name)
QdObject_var	QuGetIntervalsByNameAndComp (const QString &name)
QdObject_var	QuGetTimeByNameAndComp (const QString &name)
void	QuSetTxtAttr (const char *attrName, const char *value, QdObject_var obj)
bool	QuIsBadData (double value, double fill)
void	applyMaskToXrefs (double oldSeqLen, QdObject_var ms_out, SequenceMask msk, QdTimeSeq_var tt_out)
QdObject_var	QuCleanObject (QdObject_var dobj)
void	QuMsgBar (const char *text, bool error)
void	QuMsgBar (const char *text1, const char *text2, bool error)
void	QuSetOK ()
int	QuStrcpy (char *To, const char *From, int ToLen)
int	QuStrcat (char *To, const char *From, int ToLen)
char *	QuGetAttrConcat (const char *attrName, QdObject_var obj)
const char *	QuGetAttrCondensed (const char *attrName, QdObject_var obj)
char *	QuGetAttrText (const char *attrName, QdObject_var obj)
const char *	QuToUpper (const char *InStr)
void	QuSetFrame (QdObject_var obj, const char *txt, const char *frm=0, const char *rep=0)
char *	QuGetFrameAttr (QdObject_var obj)
char *	QuGetFrameAttr (QdObject_var obj1, QdObject_var obj2)
const char *	QuGetOrder (QdObject_var obj)
const char *	QuGetFrame (QdObject_var obj)
const char *	QuGetRep (QdObject_var obj)
bool	QuIsThreeVector (QdObject_var obj)
bool	QuIsScalar (QdObject_var obj)
char *	QuGetVectorRep (QdObject_var obj)
QdObject_var	QuGetVectorXYZ (QdObject_var dov)
void	QuSetRep (const char *rep, QdObject_var do_out)
bool	QuIsAngleDegrees (QdObject_var dobj)
double	ConvertThetaRad (double theta)
double	ConvertThetaDeg (double theta)
bool	QuIsTSRegular (QdTimeSeq_var tt, double *spacing)
char *	QuSanitizeName (const char *oldName)
bool	QuIsJoined (QdObject_var obj1, QdObject_var obj2)
int	QuArrayDims (QdObject_var obj)
bool	copyXref (const char *name, QdObject_var from_ptr, QdObject_var to_ptr)
bool	copyDimXrefs (QdObject_var from_ptr, QdObject_var to_ptr)
QdObject_var	QuGetArrayComponent (QdObject_var doa, dimTripleStack dimStack, string arrComp_xref="")
QdObject_var	QuGetVectorComponent (QdObject_var dov, const char *vcomp)
QdObject_var	QuGetTimeComponent (QdObject_var dot, const char *tcomp)
QdObject_var	QuSliceArray (QdObject_var doa, int indx, int entry)
QdObject_var	QuSumArray (QdObject_var doa, int indx, int from, int to, bool average)
QdObject_var	QuSubsetArray (QdObject_var doa, int indx, int from, int to)
bool	QuStrCmp (const char *A, const char *B)
QColor	QuGetColour (QColor inC, bool *newChoice, QWidget *parent)
void	QuGetBounds (QdTimeSeq_var tt, int &recL, int &recU, const QmjdTime &t)
bool	QuGetIvlRecBound (QdTimeSeq_var tt, int &recStart, int &recEnd, const QmjdTime &tStart, const QmjdTime &tEnd)
QdObject_var	QuSetCompFromObjText (const QString &, QString &)
QdTimeInterval_var	QuGetIvlFromSlice (QdObject_var, const dimTriple &)
bool	QuGetSliceFromIvl (QdObject_var, QdTimeInterval_var, dimTriple &)
QdTimeSeq_var	get_timetags (const QdObject_var &obj)
QdTimeInterval_var	get_timeinterval (const QdObject_var &obj)
QdTimeSeq_var	get_timetags_inrange (const QdTimeSeq_var &ts_in, const QdTimeInterval_var &tint)
double	get_time_spacing (const QdObject_var &obj)
void	set_timetags (QdObject_var obj, QdTimeSeq_var ts)
int	num_timetags_inrange (const QdTimeSeq_var &ts, const QdTimeInterval_var &tint)
bool	is_empty (const QdObject_var &obj)
void	QuNow (const char *txt)
int	QuLength (QdObject_var obj)
bool	QuSet_Array (int ndata, double *floatArray, QdObject_var obj, QdTime_var offset=0)
QdObject_var	makeSequence (QdObject_var inObj, int seqSize)
bool	QuSetObjByName (QdObject_var ToSetobj, QString name)
void	QuRenameObject (QString oldName, QString newName)
void	QuDeleteObject (const QString &name)
void	QuReplaceObject (const QString &name, QdObject_var new_obj)
QdObject_var	QuDuplicateObject (QString &name)
QString	QuNameOnly (QString nameContext)
QString	QuTextInputDialog (const char *caption, const char *label, const char *defText, bool *OK, QWidget *parent)
double	getSpacingTolerance (QdRScalarSeq_var rseq)
bool	QuGetDataRange (QdObject_var obj, double &min, double &max)
bool	QuIsBad (double value, double fill)
void	setRestoreVersion (const char *version)
QMainWindow *	getMainWindow ()
QdObject_var	QuMergeObjects (QdObject_var &dobj1, QdObject_var &dobj2)
QdObject_var	QuMergeVar (int nMask, vector< int > &pairMask, QdObject_var &dobj1, QdObject_var &dobj2)
QdObject_var	QuStripDuplicates (QdObject_var dobj, double tolerence)
QdObject_var	QuMakeMonotonic (QdObject_var dobj)
QdObject_var	applyOrder (vector< int > &order, QdObject_var dobj)
void	cleanWLtext (string &text)

---

Define Documentation

#define EVENT_0_STR   " < 0 >"

#define FILL_GAP   "fill value"

#define Ld_STR_CMP   " [ Lat (deg) ]"

#define LINEAR_INTERP_GAP   "linear interpolation"

#define Lr_STR_CMP   " [ Lat (rad) ]"

#define NEAREST_NEIGHBOUR_GAP   "nearest neighbour"

#define NEW_NAME   "new name"

#define Pd_STR_CMP   " [ phi (deg) ]"

#define Pr_STR_CMP   " [ phi (rad) ]"

#define QDUTIL_ERR   1

#define QDUTIL_OK   0

#define QDUTIL_WARN   2

#define R_STR_CMP   " [ r (mag) ]"

#define REMOVE_GAP   "remove gaps"

#define T_STR_CENTRE   " [ Centre Time ]"

#define T_STR_END   " [ End Time ]"

#define T_STR_START   " [ Start Time ]"

#define Td_STR_CMP   " [ theta (deg) ]"

#define Tr_STR_CMP   " [ theta (rad) ]"

#define X_STR_CMP   " [ x ]"

#define Y_STR_CMP   " [ y ]"

#define Z_STR_CMP   " [ z ]"

#define ZERO_FILL_GAP   "zero-fill"

---

Typedef Documentation

typedef vector<int> dimTriple

typedef vector<dimTriple> dimTripleStack

typedef enum QguComp_e QguComp

---

Enumeration Type Documentation

enum QguComp_e

Enumerator:

UNKNOWN_COMP
WL_OBJ
R_COMP
X_COMP
Y_COMP
Z_COMP
LAT_DEG_COMP
THETA_DEG_COMP
PHI_DEG_COMP
LAT_RAD_COMP
THETA_RAD_COMP
PHI_RAD_COMP
ARRAY_COMP
XREF_COMP
T_START_COMP
T_CENTRE_COMP
T_END_COMP
XREF_OBJ
SLICE_COMP

---

Function Documentation

void applyMaskToXrefs	(	double	oldSeqLen,
		QdObject_var	ms_out,
		SequenceMask	msk,
		QdTimeSeq_var	tt_out
	)

QdObject_var applyOrder	(	vector< int > &	order,
		QdObject_var	dobj
	)

QString baseObjectText

(

QString

)

QCheckBox* checkBadData

(

QWidget *

parent = 0

)

QCheckBox* checkFills

(

QWidget *

parent = 0

)

void cleanWLtext

(

string &

text

)

QguComp compEntry

(

const char *

cmpTxt

)

Method that returns the component entry in the dropdown box from the component text.

Parameters:

cmpTxt

of type const char*

Exceptions:

None

Returns:

comp of type QguComp

QguComp compEntry	(	const char *	cmpTxt,
		const char *	cmpType
	)

Method that returns the component entry in the dropdown box from the type of component and the component text.

Parameters:

	cmpTxt	of type const char*
	cmpType	of type const char*

Exceptions:

None

Returns:

comp of type QguComp

QString compText	(	QString	,
		const dimTriple &
	)

QString compText

(

QString

)

double ConvertThetaDeg

(

double

theta

)

double ConvertThetaRad

(

double

theta

)

bool copyDimXrefs	(	QdObject_var	from_ptr,
		QdObject_var	to_ptr
	)

bool copyXref	(	const char *	name,
		QdObject_var	from_ptr,
		QdObject_var	to_ptr
	)

QDomElement createTextXMLNode	(	QDomDocument &	doc,
		const QString &	parentName,
		const	bool
	)

QDomElement createTextXMLNode	(	QDomDocument &	doc,
		const QString &	parentName,
		const	int
	)

QDomElement createTextXMLNode	(	QDomDocument &	doc,
		const QString &	parentName,
		const	double
	)

QDomElement createTextXMLNode	(	QDomDocument &	doc,
		const QString &	parentName,
		const char *
	)

QDomElement createTextXMLNode	(	QDomDocument &	doc,
		const QString &	parentName,
		const std::string &
	)

QDomElement createTextXMLNode	(	QDomDocument &	doc,
		const QString &	parentName,
		const QString &
	)

QString decode

(

const QString &

input

)

QString encode

(

const QString &

input

)

double get_time_spacing

(

const QdObject_var &

obj

)

QdTimeInterval_var get_timeinterval

(

const QdObject_var &

obj

)

QdTimeSeq_var get_timetags

(

const QdObject_var &

obj

)

QdTimeSeq_var get_timetags_inrange	(	const QdTimeSeq_var &	ts_in,
		const QdTimeInterval_var &	tint
	)

dimTriple * getDimTriple

(

QString &

compTxt

)

Method that parses text in QguLineEdit and finds the array reduction requested.

Parameters:

QString

Exceptions:

None

Returns:

dimTriple *

dimTripleStack getDimTripleStack

(

QString &

compTxt

)

Method that parses text in QguLineEdit and finds the array reduction requested.

Parameters:

QString

Exceptions:

None

Returns:

dimTripleStack

QMainWindow* getMainWindow

(

)

dimTriple getSliceTriple

(

const QString &

compTxt

)

double getSpacingTolerance

(

QdRScalarSeq_var

rseq

)

bool getXMLNodeText	(	QDomElement &	el,
		const QString &	tag,
		QString &	val
	)

QString getXrefName

(

QString

objTxt

)

Method that returns the xref name from the text in the input slot.

Parameters:

objTxt

of type QString

Exceptions:

None

Returns:

text of type QString

bool is_empty

(

const QdObject_var &

obj

)

QdObject_var makeSequence	(	QdObject_var	inObj,
		int	seqSize
	)

int num_timetags_inrange	(	const QdTimeSeq_var &	ts,
		const QdTimeInterval_var &	tint
	)

int QuAreFramesSame	(	QdObject_var	ptr1,
		QdObject_var	ptr2
	)

int QuAreUnitsSame	(	QdObject_var	ptr1,
		QdObject_var	ptr2
	)

int QuArrayDims

(

QdObject_var

obj

)

QdObject_var QuCleanObject

(

QdObject_var

dobj

)

string QuCommonLabl	(	string	str1,
		string	str2
	)

void QuDeleteObject

(

const QString &

name

)

QdObject_var QuDuplicateObject

(

QString &

name

)

QdObject_var QuGetArrayComponent	(	QdObject_var	doa,
		dimTripleStack	dimStack,
		string	arrComp_xref = ""
	)

char* QuGetAttrConcat	(	const char *	attrName,
		QdObject_var	obj
	)

const char* QuGetAttrCondensed	(	const char *	attrName,
		QdObject_var	obj
	)

char* QuGetAttrText	(	const char *	attrName,
		QdObject_var	obj
	)

void QuGetBounds	(	QdTimeSeq_var	tt,
		int &	recL,
		int &	recU,
		const QmjdTime &	t
	)

QColor QuGetColour	(	QColor	inC,
		bool *	newChoice,
		QWidget *	parent
	)

bool QuGetDataRange	(	QdObject_var	obj,
		double &	min,
		double &	max
	)

QString QuGetDefaultComp	(	const QString &	WL,
		const QString &	compDef
	)

const char* QuGetFrame

(

QdObject_var

obj

)

char* QuGetFrameAttr	(	QdObject_var	obj1,
		QdObject_var	obj2
	)

char* QuGetFrameAttr

(

QdObject_var

obj

)

QdObject_var QuGetIntervalsByNameAndComp

(

const QString &

name

)

QdTimeInterval_var QuGetIvlFromSlice	(	QdObject_var	,
		const dimTriple &
	)

bool QuGetIvlRecBound	(	QdTimeSeq_var	tt,
		int &	recStart,
		int &	recEnd,
		const QmjdTime &	tStart,
		const QmjdTime &	tEnd
	)

QdObject_var QuGetObjByName

(

const QString &

name

)

QdObject_var QuGetObjByNameAndComp

(

const QString &

name

)

const char* QuGetOrder

(

QdObject_var

obj

)

const char* QuGetRep

(

QdObject_var

obj

)

bool QuGetSliceFromIvl	(	QdObject_var	,
		QdTimeInterval_var	,
		dimTriple &
	)

QdObject_var QuGetSubset	(	QdObject_var	dobj,
		int	recStart,
		int	recEnd
	)

QdObject_var QuGetTimeByNameAndComp

(

const QString &

name

)

QdObject_var QuGetTimeComponent	(	QdObject_var	dot,
		const char *	tcomp
	)

QdObject_var QuGetVectorComponent	(	QdObject_var	dov,
		const char *	vcomp
	)

char* QuGetVectorRep

(

QdObject_var

obj

)

QdObject_var QuGetVectorXYZ

(

QdObject_var

dov

)

bool QuIsAngleDegrees

(

QdObject_var

dobj

)

bool QuIsBad	(	double	value,
		double	fill
	)

bool QuIsBadData	(	double	value,
		double	fill
	)

bool QuIsJoined	(	QdObject_var	obj1,
		QdObject_var	obj2
	)

bool QuIsMatch	(	double	value,
		double	fill
	)

bool QuIsScalar

(

QdObject_var

obj

)

bool QuIsThreeVector

(

QdObject_var

obj

)

bool QuIsTSRegular	(	QdTimeSeq_var	tt,
		double *	spacing
	)

int QuLength

(

QdObject_var

obj

)

QdObject_var QuMakeMonotonic

(

QdObject_var

dobj

)

QdObject_var QuMergeObjects	(	QdObject_var &	dobj1,
		QdObject_var &	dobj2
	)

QdObject_var QuMergeVar	(	int	nMask,
		vector< int > &	pairMask,
		QdObject_var &	dobj1,
		QdObject_var &	dobj2
	)

void QuMsgBar	(	const char *	text1,
		const char *	text2,
		bool	error
	)

void QuMsgBar	(	const char *	text,
		bool	error
	)

QString QuNameOnly

(

QString

nameContext

)

char* QuNewSTR

(

const char *

in_str

)

void QuNow

(

const char *

txt

)

void QuRenameObject	(	QString	oldName,
		QString	newName
	)

void QuReplaceObject	(	const QString &	name,
		QdObject_var	new_obj
	)

void QuReplaceTokens	(	QString &	newTxt,
		QString &	oldTxt
	)

char* QuSanitizeName

(

const char *

oldName

)

bool QuSet_Array	(	int	ndata,
		double *	floatArray,
		QdObject_var	obj,
		QdTime_var	offset = 0
	)

QdObject_var QuSetCompFromObjText	(	const QString &	,
		QString &
	)

void QuSetFrame	(	QdObject_var	obj,
		const char *	txt,
		const char *	frm = 0,
		const char *	rep = 0
	)

bool QuSetObjByName	(	QdObject_var	ToSetobj,
		QString	name
	)

void QuSetOK

(

)

void QuSetRep	(	const char *	rep,
		QdObject_var	do_out
	)

void QuSetTxtAttr	(	const char *	attrName,
		const char *	value,
		QdObject_var	obj
	)

QdObject_var QuSliceArray	(	QdObject_var	doa,
		int	indx,
		int	entry
	)

bool QuSlotDebug

(

)

int QuStrcat	(	char *	To,
		const char *	From,
		int	ToLen
	)

bool QuStrCmp	(	const char *	A,
		const char *	B
	)

int QuStrcpy	(	char *	To,
		const char *	From,
		int	ToLen
	)

QdObject_var QuStripDuplicates	(	QdObject_var	dobj,
		double	tolerence
	)

QdObject_var QuSubsetArray	(	QdObject_var	doa,
		int	indx,
		int	from,
		int	to
	)

QdObject_var QuSumArray	(	QdObject_var	doa,
		int	indx,
		int	from,
		int	to,
		bool	average
	)

QdObject_var QuTakeSlice	(	vector< string >	objectNameList,
		QdObject_var	dobj,
		dimTriple	sliceTriple,
		bool	getInterval
	)

QString QuTextInputDialog	(	const char *	caption,
		const char *	label,
		const char *	defText,
		bool *	OK,
		QWidget *	parent
	)

const char* QuToUpper

(

const char *

InStr

)

void set_timetags	(	QdObject_var	obj,
		QdTimeSeq_var	ts
	)

void setRestoreVersion

(

const char *

version

)