MCGIDI_misc.h File Reference

#include <statusMessageReporting.h>
#include <xDataTOM_importXML_private.h>
#include "MCGIDI_private.h"

Go to the source code of this file.

Macros
#define	MCGIDI_misc_pointerToTOMAttributeIfAllOk2(smr, required, attributes, name)
#define	MCGIDI_misc_pointerToTOMAttributeIfAllOk3(smr, path, required, attributes, name)
#define	MCGIDI_misc_pointerToAttributeIfAllOk2(smr, element, required, attributes, name)
#define	MCGIDI_misc_pointerToAttributeIfAllOk3(smr, path, required, attributes, name)

Functions
char const *	MCGIDI_misc_pointerToTOMAttributeIfAllOk (statusMessageReporting *smr, char const *path, int required, xDataTOM_attributionList *attributes, char const *name, char const *file, int line)
char const *	MCGIDI_misc_pointerToAttributeIfAllOk (statusMessageReporting *smr, xDataXML_element *element, char const *path, int required, xDataTOM_attributionList *attributes, char const *name, char const *file, int line)
int	MCGIDI_misc_setMessageError_Element (statusMessageReporting *smr, void *userInterface, xDataXML_element *element, char const *file, int line, int code, char const *fmt,...)
char *	MCGIDI_misc_getAbsPath (statusMessageReporting *smr, char const *fileName)
int	MCGIDI_misc_copyXMLAttributesToTOM (statusMessageReporting *smr, xDataTOM_attributionList *TOM, xDataXML_attributionList *XML)
enum xDataTOM_frame	MCGIDI_misc_getProductFrame (statusMessageReporting *smr, xDataTOM_element *frameElement)
double	MCGIDI_misc_getUnitConversionFactor (statusMessageReporting *smr, char const *fromUnit, char const *toUnit)
ptwXYPoints *	MCGIDI_misc_dataFromXYs2ptwXYPointsInUnitsOf (statusMessageReporting *smr, xDataTOM_XYs *XYs, ptwXY_interpolation interpolation, char const *units[2])
ptwXYPoints *	MCGIDI_misc_dataFromElement2ptwXYPointsInUnitsOf (statusMessageReporting *smr, xDataTOM_element *linear, char const *toUnits[2])

Macro Definition Documentation

MCGIDI_misc_pointerToAttributeIfAllOk2

#define MCGIDI_misc_pointerToAttributeIfAllOk2	(		smr,
			element,
			required,
			attributes,
			name )

Value:

    MCGIDI_misc_pointerToAttributeIfAllOk( smr, element, NULL, required, attributes, name, __FILE__, __LINE__ )

Definition at line 31 of file MCGIDI_misc.h.

#define MCGIDI_misc_pointerToAttributeIfAllOk2( smr, element, required, attributes, name ) \
    MCGIDI_misc_pointerToAttributeIfAllOk( smr, element, NULL, required, attributes, name, __FILE__, __LINE__ )

MCGIDI_misc_pointerToAttributeIfAllOk3

#define MCGIDI_misc_pointerToAttributeIfAllOk3	(		smr,
			path,
			required,
			attributes,
			name )

Value:

    MCGIDI_misc_pointerToAttributeIfAllOk( smr, NULL, path, required, attributes, name, __FILE__, __LINE__ )

Definition at line 33 of file MCGIDI_misc.h.

#define MCGIDI_misc_pointerToAttributeIfAllOk3( smr, path, required, attributes, name ) \
    MCGIDI_misc_pointerToAttributeIfAllOk( smr, NULL, path, required, attributes, name, __FILE__, __LINE__ )

MCGIDI_misc_pointerToTOMAttributeIfAllOk2

#define MCGIDI_misc_pointerToTOMAttributeIfAllOk2	(		smr,
			required,
			attributes,
			name )

Value:

    MCGIDI_misc_pointerToTOMAttributeIfAllOk( smr, NULL, required, attributes, name, __FILE__, __LINE__ )

Definition at line 26 of file MCGIDI_misc.h.

#define MCGIDI_misc_pointerToTOMAttributeIfAllOk2( smr, required, attributes, name ) \
    MCGIDI_misc_pointerToTOMAttributeIfAllOk( smr, NULL, required, attributes, name, __FILE__, __LINE__ )

MCGIDI_misc_pointerToTOMAttributeIfAllOk3

#define MCGIDI_misc_pointerToTOMAttributeIfAllOk3	(		smr,
			path,
			required,
			attributes,
			name )

Value:

    MCGIDI_misc_pointerToTOMAttributeIfAllOk( smr, path, required, attributes, name, __FILE__, __LINE__ )

Definition at line 28 of file MCGIDI_misc.h.

#define MCGIDI_misc_pointerToTOMAttributeIfAllOk3( smr, path, required, attributes, name ) \
    MCGIDI_misc_pointerToTOMAttributeIfAllOk( smr, path, required, attributes, name, __FILE__, __LINE__ )

Referenced by MCGIDI_target_heated_read().

Function Documentation

MCGIDI_misc_copyXMLAttributesToTOM()

int MCGIDI_misc_copyXMLAttributesToTOM	(	statusMessageReporting *	smr,
		xDataTOM_attributionList *	TOM,
		xDataXML_attributionList *	XML )

Definition at line 296 of file MCGIDI_misc.cc.

                                                                                                                                    {
 
    int i;
    xDataXML_attribute *attribute;
 
    xDataTOMAL_initial( smr, TOM );
    for( i = 0; ; i++ ) {
        if( ( attribute = xDataXML_attributeByIndex( XML, i ) ) == NULL ) break;
        if( xDataTOMAL_addAttribute( smr, TOM, attribute->name, attribute->value ) != 0 ) goto err;
    }
    return( 0 );
 
err:
    xDataTOMAL_release( TOM );
    return( 1 );
}

MCGIDI_misc_dataFromElement2ptwXYPointsInUnitsOf()

ptwXYPoints * MCGIDI_misc_dataFromElement2ptwXYPointsInUnitsOf	(	statusMessageReporting *	smr,
		xDataTOM_element *	linear,
		char const *	toUnits[2] )

Definition at line 424 of file MCGIDI_misc.cc.

                                                                                                                                               {
 
    int length;
    double *data;
    xDataTOM_axes *axes = &(linear->xDataInfo.axes);
    char const *fromUnits[2];
    ptwXY_interpolation interpolation;
 
    if( axes->numberOfAxes != 2 ) {
        smr_setReportError2( smr, smr_unknownID, 1, "axes must have 2 axis, it has %d", axes->numberOfAxes );
        return( NULL );
    }
 
    if( MCGIDI_fromTOM_interpolation( smr, linear, 0, &interpolation ) != 0 ) return( NULL );
    fromUnits[0] = axes->axis[0].unit;
    fromUnits[1] = axes->axis[1].unit;
 
    length = xDataTOM_XYs_getDataFromXDataInfo( (xDataTOM_xDataInfo *) &(linear->xDataInfo), &data );
    return( MCGIDI_misc_Data2ptwXYPointsInUnitsOf( smr, interpolation, length, data, fromUnits, toUnits ) );
}

Referenced by MCGIDI_product_parseFromTOM(), and MCGIDI_reaction_parseFromTOM().

MCGIDI_misc_dataFromXYs2ptwXYPointsInUnitsOf()

ptwXYPoints * MCGIDI_misc_dataFromXYs2ptwXYPointsInUnitsOf	(	statusMessageReporting *	smr,
		xDataTOM_XYs *	XYs,
		ptwXY_interpolation	interpolation,
		char const *	units[2] )

Definition at line 405 of file MCGIDI_misc.cc.

                                                                    {
 
    int length;
    double *data;
    char const *fromUnits[2];
 
    fromUnits[0] = xDataTOM_subAxes_getUnit( smr, &(XYs->subAxes), 0 );
    if( !smr_isOk( smr ) ) return( NULL );
    fromUnits[1] = xDataTOM_subAxes_getUnit( smr, &(XYs->subAxes), 1 );
    if( !smr_isOk( smr ) ) return( NULL );
 
    length = xDataTOM_XYs_getData( XYs, &data );
 
    return( MCGIDI_misc_Data2ptwXYPointsInUnitsOf( smr, interpolation, length, data, fromUnits, toUnits ) );
}

Referenced by MCGIDI_angular_parseFromTOM(), and MCGIDI_fromTOM_pdfsOfXGivenW().

MCGIDI_misc_getAbsPath()

char * MCGIDI_misc_getAbsPath	(	statusMessageReporting *	smr,
		char const *	fileName )

Definition at line 250 of file MCGIDI_misc.cc.

                                                                                  {
/*
*   User must free returned string.
*/
    int n = (int) strlen( fileName ) + 1, nCwd = 0;
    char *absPath, cwd[4 * 1024] = "", *p, *needle;
 
    if( fileName[0] != '/' ) {
        //if( getcwd( cwd, sizeof( cwd ) + 1 ) == NULL ) {
        //TK modified above line for compiler(gcc.4.8) warning message
        if( getcwd( cwd, sizeof( cwd ) ) == NULL ) {
            smr_setReportError2p( smr, smr_unknownID, -1, "hardwired cwd too small" );
            return( NULL );
        }
        nCwd = (int) strlen( cwd );
        n += nCwd + 1;                                  /* cwd + '/'. */
    }
    if( ( absPath = (char *) smr_malloc2( smr, n, 0, "absPath" ) ) == NULL ) return( NULL );
    if( fileName[0] != '/' ) {
        strcpy( absPath, cwd );
        strcat( absPath, "/" );
        strcat( absPath, fileName ); }
    else {
        strcpy( absPath, fileName );
    }
 
    while( 1 ) {                                        /* Remove all ./ from path. */ // Loop checking, 11.06.2015, T. Koi
        if( ( needle = strstr( absPath, "/./" ) ) == NULL ) break;
        p = needle;
        for( needle += 2; *needle; p++, needle++ ) *p = *needle;
        *p = 0;
    }
    while( 1 ) {                                        /* Remove all ../ from path. */ // Loop checking, 11.06.2015, T. Koi
        if( ( needle = strstr( absPath, "/../" ) ) == NULL ) break;
        p = needle - 1;
        while( ( p > absPath ) && ( *p != '/' ) ) p--; // Loop checking, 11.06.2015, T. Koi
        if( *p != '/' ) break;                           /* This should not happen if path is legit, I think, and I do not know what to do so will leave it. */
        if( p == absPath ) break;                       /* Ditto. */
        for( needle += 3; *needle; p++, needle++ ) *p = *needle;
        *p = 0;
    }
    return( absPath );
}

Referenced by MCGIDI_target_read().

MCGIDI_misc_getProductFrame()

enum xDataTOM_frame MCGIDI_misc_getProductFrame	(	statusMessageReporting *	smr,
		xDataTOM_element *	frameElement )

Definition at line 315 of file MCGIDI_misc.cc.

                                                                                                               {
 
    char const *frameString;
    enum xDataTOM_frame frame = xDataTOM_frame_invalid;
 
    if( ( frameString = xDataTOM_getAttributesValueInElement( frameElement, MCGIDI_token_productFrame ) ) != NULL ) {
        if( ( frame = xDataTOM_axis_stringToFrame( smr, frameString ) ) == xDataTOM_frame_invalid ) {
            smr_setReportError2( smr, smr_unknownID, 1, "Invalid frame = '%s'", frameString );
        }
    }
    return( frame );
}

Referenced by MCGIDI_angular_parseFromTOM(), MCGIDI_energy_parseFromTOM(), and MCGIDI_KalbachMann_parseFromTOM().

MCGIDI_misc_getUnitConversionFactor()

double MCGIDI_misc_getUnitConversionFactor	(	statusMessageReporting *	smr,
		char const *	fromUnit,
		char const *	toUnit )

Definition at line 381 of file MCGIDI_misc.cc.

                                                                                                                    {
/*
*   This is a kludge until units are better supported.
*/
    if( strcmp( fromUnit, toUnit ) == 0 ) return( 1.0 );
 
    if( strcmp( fromUnit, "eV" ) == 0 ) {
        if( strcmp( toUnit, "MeV" ) == 0 ) return( 1e-6 ); }
    else if( strcmp( fromUnit, "MeV" ) == 0 ) {
        if( strcmp( toUnit, "eV" ) == 0 ) return( 1e+6 ); }
    else if( strcmp( fromUnit, "1/eV" ) == 0 ) {
        if( strcmp( toUnit, "1/MeV" ) == 0 ) return( 1e+6 ); }
    else if( strcmp( fromUnit, "1/MeV" ) == 0 ) {
        if( strcmp( toUnit, "1/eV" ) == 0 ) return( 1e-6 ); }
    else if( strcmp( fromUnit, "K" ) == 0 ) {
        if( strcmp( toUnit, "MeV/k" ) == 0 ) return( 8.617343183775137e-11 );
    }
 
    smr_setReportError2( smr, smr_unknownID, 1, "Cannot convert unit '%s' to unit '%s'", fromUnit, toUnit );
    return( 1.0 );
}

Referenced by MCGIDI_angular_parseFromTOM(), MCGIDI_fromTOM_pdfsOfXGivenW(), MCGIDI_KalbachMann_parseFromTOM(), MCGIDI_misc_PQUStringToDoubleInUnitOf(), and MCGIDI_target_heated_read().

MCGIDI_misc_pointerToAttributeIfAllOk()

char const * MCGIDI_misc_pointerToAttributeIfAllOk	(	statusMessageReporting *	smr,
		xDataXML_element *	element,
		char const *	path,
		int	required,
		xDataTOM_attributionList *	attributes,
		char const *	name,
		char const *	file,
		int	line )

Definition at line 184 of file MCGIDI_misc.cc.

                                                                                             {
 
    char const *value;
 
    if( !smr_isOk( smr ) ) return( NULL );
    if( ( value = xDataTOMAL_getAttributesValue( attributes, name ) ) == NULL ) {
        if( required ) {
            if( element != NULL ) {
                MCGIDI_misc_setMessageError_Element( smr, NULL, element, file, line, 1, "element does not have attribute named %s", name ); }
            else {
                smr_setReportError( smr, NULL, file, line, __func__, smr_unknownID, 1, "element does not have attribute named %s for file = %d", name, path );
            }
        }
    }
    return( value );
}

MCGIDI_misc_pointerToTOMAttributeIfAllOk()

char const * MCGIDI_misc_pointerToTOMAttributeIfAllOk	(	statusMessageReporting *	smr,
		char const *	path,
		int	required,
		xDataTOM_attributionList *	attributes,
		char const *	name,
		char const *	file,
		int	line )

Definition at line 168 of file MCGIDI_misc.cc.

                                                                                             {
 
    char const *value;
 
    if( !smr_isOk( smr ) ) return( NULL );
    if( ( value = xDataTOMAL_getAttributesValue( attributes, name ) ) == NULL ) {
        if( required ) {
            smr_setReportError( smr, NULL, file, line, __func__, smr_unknownID, 1, "element does not have attribute named %s for file = %d", name, path );
        }
    }
    return( value );
}

MCGIDI_misc_setMessageError_Element()

int MCGIDI_misc_setMessageError_Element	(	statusMessageReporting *	smr,
		void *	userInterface,
		xDataXML_element *	element,
		char const *	file,
		int	line,
		int	code,
		char const *	fmt,
			... )

Definition at line 204 of file MCGIDI_misc.cc.

                           {
 
    int status = 0;
    va_list args;
    char *msg;
 
    va_start( args, fmt );
    msg = smr_vallocateFormatMessage( fmt, &args );
    va_end( args );
    if( msg == NULL ) {
        status = 1;
        va_start( args, fmt );
        smr_vsetReportError( smr, userInterface, file, line, __func__, smr_unknownID, code, fmt, &args );
        va_end( args ); }
    else {
        status = smr_setReportError( smr, userInterface, file, line, __func__, smr_unknownID, code, "%s for element %s", msg, element->name );
        smr_freeMemory( (void **) &msg );
    }
    return( status );
}

Referenced by MCGIDI_misc_pointerToAttributeIfAllOk(), and MCGIDI_target_read().