MCGIDI_map.h File Reference

#include <statusMessageReporting.h>

Go to the source code of this file.

Classes
struct	MCGIDI_map_smr_s
struct	MCGIDI_mapEntry_s
struct	MCGIDI_map_s

Typedefs
typedef struct MCGIDI_map_s	MCGIDI_map
typedef struct MCGIDI_mapEntry_s	MCGIDI_mapEntry
typedef struct MCGIDI_map_smr_s	MCGIDI_map_smr

Enumerations
enum	MCGIDI_map_status { MCGIDI_map_status_Ok , MCGIDI_map_status_memory , MCGIDI_map_status_mapParsing , MCGIDI_map_status_UnknownType }
enum	MCGIDI_mapEntry_type { MCGIDI_mapEntry_type_target , MCGIDI_mapEntry_type_path }

Functions
MCGIDI_map *	MCGIDI_map_new (statusMessageReporting *smr)
int	MCGIDI_map_initialize (statusMessageReporting *smr, MCGIDI_map *map)
MCGIDI_map *	MCGIDI_map_readFile (statusMessageReporting *smr, const char *basePath, const char *mapFileName)
void *	MCGIDI_map_free (statusMessageReporting *smr, MCGIDI_map *map)
void	MCGIDI_map_release (statusMessageReporting *smr, MCGIDI_map *map)
MCGIDI_mapEntry *	MCGIDI_map_getFirstEntry (MCGIDI_map *map)
MCGIDI_mapEntry *	MCGIDI_map_getNextEntry (MCGIDI_mapEntry *entry)
int	MCGIDI_map_addTarget (statusMessageReporting *smr, MCGIDI_map *map, const char *method, const char *path, const char *evaluation, const char *projectile, const char *targetName)
int	MCGIDI_map_addPath (statusMessageReporting *smr, MCGIDI_map *map, const char *path)
char *	MCGIDI_map_findTargetViaPoPIDs (statusMessageReporting *smr, MCGIDI_map *map, const char *evaluation, int projectile_PoPID, int target_PoPID)
char *	MCGIDI_map_findTarget (statusMessageReporting *smr, MCGIDI_map *map, const char *evaluation, const char *projectile, const char *targetName)
MCGIDI_map *	MCGIDI_map_findAllOfTargetViaPoPIDs (statusMessageReporting *smr, MCGIDI_map *map, int projectile_PoPID, int target_PoPID)
MCGIDI_map *	MCGIDI_map_findAllOfTarget (statusMessageReporting *smr, MCGIDI_map *map, const char *projectile, const char *targetName)
char *	MCGIDI_map_getFullPath (statusMessageReporting *smr, MCGIDI_map *map, const char *endPath)
char *	MCGIDI_map_getTargetsFullPath (statusMessageReporting *smr, MCGIDI_mapEntry *target)
int	MCGIDI_map_walkTree (statusMessageReporting *smr, MCGIDI_map *map, int(*handler)(MCGIDI_mapEntry *entry, int level, void *userData), void *userData)
char *	MCGIDI_map_toXMLString (statusMessageReporting *smr, MCGIDI_map *map)
void	MCGIDI_map_simpleWrite (FILE *f, MCGIDI_map *map)

Typedef Documentation

MCGIDI_map

typedef struct MCGIDI_map_s MCGIDI_map

Definition at line 19 of file MCGIDI_map.h.

MCGIDI_map_smr

typedef struct MCGIDI_map_smr_s MCGIDI_map_smr

Definition at line 21 of file MCGIDI_map.h.

MCGIDI_mapEntry

typedef struct MCGIDI_mapEntry_s MCGIDI_mapEntry

Definition at line 20 of file MCGIDI_map.h.

Enumeration Type Documentation

MCGIDI_map_status

enum MCGIDI_map_status

Enumerator
MCGIDI_map_status_Ok
MCGIDI_map_status_memory
MCGIDI_map_status_mapParsing
MCGIDI_map_status_UnknownType

Definition at line 15 of file MCGIDI_map.h.

                       { MCGIDI_map_status_Ok, MCGIDI_map_status_memory, MCGIDI_map_status_mapParsing,
    MCGIDI_map_status_UnknownType };

MCGIDI_mapEntry_type

enum MCGIDI_mapEntry_type

Enumerator
MCGIDI_mapEntry_type_target
MCGIDI_mapEntry_type_path

Definition at line 17 of file MCGIDI_map.h.

{ MCGIDI_mapEntry_type_target, MCGIDI_mapEntry_type_path };

Function Documentation

MCGIDI_map_addPath()

int MCGIDI_map_addPath	(	statusMessageReporting *	smr,
		MCGIDI_map *	map,
		const char *	path )

Definition at line 225 of file MCGIDI_map.cc.

                                                                                         {
 
    MCGIDI_mapEntry *entry = _MCGIDI_map_addEntry( smr, map, MCGIDI_mapEntry_type_path, NULL, path, NULL, NULL, NULL );
 
    if( entry != NULL ) {
        if( ( entry->map = MCGIDI_map_readFile( smr, map->path, entry->path ) ) == NULL ) entry = NULL;
    }
    return( entry != NULL );
}

Referenced by MCGIDI_map_readFile().

MCGIDI_map_addTarget()

int MCGIDI_map_addTarget	(	statusMessageReporting *	smr,
		MCGIDI_map *	map,
		const char *	method,
		const char *	path,
		const char *	evaluation,
		const char *	projectile,
		const char *	targetName )

Definition at line 218 of file MCGIDI_map.cc.

                                                                                                                                                                                   {
 
    return( _MCGIDI_map_addEntry( smr, map, MCGIDI_mapEntry_type_target, schema, path, evaluation, projectile, target ) != NULL );
}

Referenced by MCGIDI_map_readFile().

MCGIDI_map_findAllOfTarget()

MCGIDI_map * MCGIDI_map_findAllOfTarget	(	statusMessageReporting *	smr,
		MCGIDI_map *	map,
		const char *	projectile,
		const char *	targetName )

Definition at line 430 of file MCGIDI_map.cc.

                                                                                                                                       {
 
    int projectile_PoPID, target_PoPID;
    
    if( ( projectile_PoPID = lPoPs_addParticleIfNeeded( smr, projectile, "LLNL" ) ) < 0 ) return( NULL );
    if( ( target_PoPID     = lPoPs_addParticleIfNeeded( smr, targetName, "LLNL" ) ) < 0 ) return( NULL );
    return( MCGIDI_map_findAllOfTargetViaPoPIDs( smr, map, projectile_PoPID, target_PoPID ) );
}

Referenced by G4GIDI::getNamesOfAvailableLibraries().

MCGIDI_map_findAllOfTargetViaPoPIDs()

MCGIDI_map * MCGIDI_map_findAllOfTargetViaPoPIDs	(	statusMessageReporting *	smr,
		MCGIDI_map *	map,
		int	projectile_PoPID,
		int	target_PoPID )

Definition at line 387 of file MCGIDI_map.cc.

                       {
/*
* Calling routine must free returned pointer.
*/
    int status;
    MCGIDI_map *mapAllOfTarget;
    
    if( map->status != MCGIDI_map_status_Ok ) return( NULL );
    if( ( mapAllOfTarget = MCGIDI_map_new( smr ) ) == NULL ) return( NULL );
    status = _MCGIDI_map_findAllOfTargetViaPoPIDs2( smr, mapAllOfTarget, map, projectile_PoPID, target_PoPID );
    if( ( status != 0 ) ) mapAllOfTarget = (MCGIDI_map *) MCGIDI_map_free( smr, mapAllOfTarget );
    return( mapAllOfTarget );
}

Referenced by MCGIDI_map_findAllOfTarget().

MCGIDI_map_findTarget()

char * MCGIDI_map_findTarget	(	statusMessageReporting *	smr,
		MCGIDI_map *	map,
		const char *	evaluation,
		const char *	projectile,
		const char *	targetName )

Definition at line 376 of file MCGIDI_map.cc.

                                                                                                                                                    {
 
    int projectile_PoPID, target_PoPID;
 
    if( ( projectile_PoPID = lPoPs_addParticleIfNeeded( smr, projectile, "LLNL" ) ) < 0 ) return( NULL );
    if( ( target_PoPID     = lPoPs_addParticleIfNeeded( smr, targetName, "LLNL" ) ) < 0 ) return( NULL );
    return( MCGIDI_map_findTargetViaPoPIDs( smr, map, evaluation, projectile_PoPID, target_PoPID ) );
}

Referenced by G4GIDI::dataFilename(), MCGIDI_target_newReadFromMap(), and MCGIDI_target_readFromMap().

MCGIDI_map_findTargetViaPoPIDs()

char * MCGIDI_map_findTargetViaPoPIDs	(	statusMessageReporting *	smr,
		MCGIDI_map *	map,
		const char *	evaluation,
		int	projectile_PoPID,
		int	target_PoPID )

Definition at line 302 of file MCGIDI_map.cc.

                                             {
/*
* Calling routine must free returned pointer.
*/
    char *path;
    char const *projectileName = PoPs_getName_atIndex( smr, projectile_PoPID );
    char const *targetName = PoPs_getName_atIndex( smr, target_PoPID );
 
    if( !smr_isOk( smr ) ) return( NULL );
    if( map->status != MCGIDI_map_status_Ok ) return( NULL );
 
    path = _MCGIDI_map_findTargetViaPoPIDs2( smr, map, evaluation, projectile_PoPID, target_PoPID );
    if( ( path == NULL ) && smr_isOk( smr ) ) {
        if( evaluation == NULL ) {
            smr_setReportInfo3( smr, &(map->smrUserInterface), smr_unknownID, 1, "target %s for projectile %s not found", 
                targetName, projectileName ); }
        else {
            smr_setReportInfo3( smr, &(map->smrUserInterface), smr_unknownID, 1, "target %s for projectile %s and evaluation %s not found", 
                targetName, projectileName, evaluation );
        }
    }
    return( path );
}

Referenced by MCGIDI_map_findTarget(), MCGIDI_target_newReadFromMapViaPoPIDs(), and MCGIDI_target_readFromMapViaPoPIDs().

MCGIDI_map_free()

void * MCGIDI_map_free	(	statusMessageReporting *	smr,
		MCGIDI_map *	map )

Definition at line 173 of file MCGIDI_map.cc.

                                                                      {
 
    MCGIDI_map_release( smr, map );
    smr_freeMemory( (void **) &map );
    return( NULL );
}

Referenced by G4GIDI::getNamesOfAvailableLibraries(), MCGIDI_map_findAllOfTargetViaPoPIDs(), MCGIDI_map_new(), MCGIDI_map_readFile(), MCGIDI_map_release(), and G4GIDI_map::~G4GIDI_map().

MCGIDI_map_getFirstEntry()

MCGIDI_mapEntry * MCGIDI_map_getFirstEntry

(

MCGIDI_map *

map

)

Definition at line 204 of file MCGIDI_map.cc.

                                                             {
 
    return( map->mapEntries );
}

Referenced by G4GIDI::getNamesOfAvailableLibraries().

MCGIDI_map_getFullPath()

char * MCGIDI_map_getFullPath	(	statusMessageReporting *	smr,
		MCGIDI_map *	map,
		const char *	endPath )

Definition at line 441 of file MCGIDI_map.cc.

                                                                                                  {
 
    char *path;
 
    if( endPath[0] == '/' ) {
        if( ( path = (char *) smr_malloc2( smr, strlen( endPath ) + 1, 0, "path" ) ) == NULL ) return( NULL );
        path[0] = 0; }
    else {
        if( ( path = (char *) smr_malloc2( smr, strlen( map->path ) + strlen( endPath ) + 2, 0, "path" ) ) == NULL ) return( NULL );
        strcpy( path, map->path );
        strcat( path, "/" );
    }
    strcat( path, endPath );
    return( path );
}

Referenced by MCGIDI_map_getTargetsFullPath().

MCGIDI_map_getNextEntry()

MCGIDI_mapEntry * MCGIDI_map_getNextEntry

(

MCGIDI_mapEntry *

entry

)

Definition at line 211 of file MCGIDI_map.cc.

                                                                   {
 
    return( entry->next );
}

Referenced by G4GIDI::getNamesOfAvailableLibraries().

MCGIDI_map_getTargetsFullPath()

char * MCGIDI_map_getTargetsFullPath	(	statusMessageReporting *	smr,
		MCGIDI_mapEntry *	target )

Definition at line 459 of file MCGIDI_map.cc.

                                                                                            {
 
    char *path = NULL;
    MCGIDI_map *map = target->parent;
 
    switch( target->type ) {
    case MCGIDI_mapEntry_type_target :
        path = MCGIDI_map_getFullPath( smr, map, target->path );
        break;
    case MCGIDI_mapEntry_type_path :
        smr_setReportInfo3p( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_UnknownType, "path type not allowed" );
        break;
    default :
        smr_setReportInfo3( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_UnknownType, "unknown type = %d", target->type );
        break;
    }
    return( path );
}

MCGIDI_map_initialize()

int MCGIDI_map_initialize	(	statusMessageReporting *	smr,
		MCGIDI_map *	map )

Definition at line 60 of file MCGIDI_map.cc.

                                                                          {
 
    memset( map, 0, sizeof( MCGIDI_map ) );
    map->status = MCGIDI_map_status_Ok;
    map->smrUserInterface.smrUserInterface = _MCGIDI_map_smrUserInterface;
    map->smrUserInterface.map = map;
    map->path = NULL;
    map->mapFileName = NULL;
    map->numberOfEntries = 0;
    map->mapEntries = NULL;
 
/*
*   Add some default aliases. This is a kludge until aliases are fully supported.
*/
if( aliasesNeeded ) { /* Support all meta-stables in ENDF/B-VII.1 */
    char const *aliases[] = { "Co58m1",  "Ag110m1",  "Cd115m1",  "Te127m1",  "Te129m1",  "Pm148m1",  "Ho166m1",  "Am242m1",  "Am244m1",  "Es254m1" };
    char const *targets[] = { "Co58_e1", "Ag110_e2", "Cd115_e1", "Te127_e2", "Te129_e1", "Pm148_e2", "Ho166_e1", "Am242_e2", "Am244_e1", "Es254_e2" };
    int i1, n1 = sizeof( aliases ) / sizeof( aliases[1] );
    
 
    for( i1 = 0; i1 < n1; i1++ ) {
        lPoPs_addParticleIfNeeded( smr, targets[i1], NULL );
        if( !smr_isOk( smr ) ) return( 1 );
        PoPs_addAliasIfNeeded( smr, targets[i1], aliases[i1] );
        if( !smr_isOk( smr ) ) return( 1 );
    }
    aliasesNeeded = 0;
}
    return( 0 );
}

Referenced by MCGIDI_map_new().

MCGIDI_map_new()

MCGIDI_map * MCGIDI_map_new

(

statusMessageReporting *

smr

)

Definition at line 49 of file MCGIDI_map.cc.

                                                          {
 
    MCGIDI_map *map;
    
    if( ( map = (MCGIDI_map *) smr_malloc2( smr, sizeof( MCGIDI_map ), 0, "map" ) ) == NULL ) return( NULL );
    if( MCGIDI_map_initialize( smr, map ) ) map = (MCGIDI_map *) MCGIDI_map_free( NULL, map );
    return( map );
}

Referenced by MCGIDI_map_findAllOfTargetViaPoPIDs(), and MCGIDI_map_readFile().

MCGIDI_map_readFile()

MCGIDI_map * MCGIDI_map_readFile	(	statusMessageReporting *	smr,
		const char *	basePath,
		const char *	mapFileName )

Definition at line 93 of file MCGIDI_map.cc.

                                                                                                              {
/*
*   If an error occurrs, map is freed and NULL is returned.
*/
    int n = 0;
    xDataXML_document *doc;
    xDataXML_element *element;
    xDataXML_element *child;
    MCGIDI_map *map;
    const char *evaluation, *projectile, *targetName, *path, *schema;
    char realPath[2 * ( PATH_MAX + 1 )], *p = &(realPath[PATH_MAX+1]);
 
    if( ( map = MCGIDI_map_new( smr ) ) == NULL ) return( NULL );
 
    if( ( basePath == NULL ) || ( mapFileName[0] == '/' ) ) {
        strcpy( realPath, mapFileName ); }
    else {
        strcpy( realPath, basePath );
        strcat( realPath, "/" );
        strcat( realPath, mapFileName );
    }
    if( realpath( realPath, p ) == NULL ) {
        smr_setReportError2( smr, smr_unknownID, MCGIDI_map_status_mapParsing, "No map file %s\n", mapFileName );
        return( (MCGIDI_map *) MCGIDI_map_free( NULL, map ) );
    }
    n = (int) strlen( p ) + 2;
    if( ( map->path = (char *) smr_malloc2( smr, 2 * n, 0, "map->path" ) ) == NULL ) return( (MCGIDI_map *) MCGIDI_map_free( NULL, map ) );
    map->mapFileName = &(map->path[n + 1]);
    strcpy( map->mapFileName, p );
    strcpy( map->path, p );
    if( ( p = strrchr( map->path, '/' ) ) != NULL ) {
        *p = 0; }
    else {
        strcpy( map->path, "." );
    }
 
    if( ( doc = xDataXML_importFile2( smr, map->mapFileName ) ) == NULL ) return( (MCGIDI_map *) MCGIDI_map_free( NULL, map ) );
 
    element = xDataXML_getDocumentsElement( doc );
    for( child = xDataXML_getFirstElement( element ); child != NULL; child = xDataXML_getNextElement( child ) ) {
        if( strcmp( child->name, "path" ) == 0 ) {
            if( ( path = xDataXML_getAttributesValueInElement( child , "path" ) ) == NULL ) {
                smr_setReportError3p( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_mapParsing, "path missing path attribute" );
                break;
            }
            MCGIDI_map_addPath( smr, map, path ); }
        else if( strcmp( child->name, "target" ) == 0 ) {
            if( ( schema = xDataXML_getAttributesValueInElement( child , "schema" ) ) == NULL ) {
                smr_setReportError3p( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_mapParsing, "target missing 'schema' attribute" );
                break;
            }
            if( ( path = xDataXML_getAttributesValueInElement( child , "path" ) ) == NULL ) {
                smr_setReportError3p( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_mapParsing, "target missing 'path' attribute" );
                break;
            }
            if( ( evaluation = xDataXML_getAttributesValueInElement( child , "evaluation" ) ) == NULL ) {
                smr_setReportError3p( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_mapParsing, "target missing 'evaluation' attribute" );
                break;
            }
            if( ( projectile = xDataXML_getAttributesValueInElement( child , "projectile" ) ) == NULL ) {
                smr_setReportError3p( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_mapParsing, "target missing 'projectile' attribute" );
                break;
            }
            if( ( targetName = xDataXML_getAttributesValueInElement( child , "target" ) ) == NULL ) {
                smr_setReportError3p( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_mapParsing, "target missing 'target' attribute" );
                break;
            }
            MCGIDI_map_addTarget( smr, map, schema, path, evaluation, projectile, targetName ); }
        else {
            smr_setReportError3( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_mapParsing, "invalid element = %s", child->name );
        }
        if( !smr_isOk( smr ) ) break;
    }
    xDataXML_freeDoc( smr, doc );
    if( !smr_isOk( smr ) ) map = (MCGIDI_map *) MCGIDI_map_free( NULL, map );
    return( map );
}

Referenced by G4GIDI_map::G4GIDI_map(), and MCGIDI_map_addPath().

MCGIDI_map_release()

void MCGIDI_map_release	(	statusMessageReporting *	smr,
		MCGIDI_map *	map )

Definition at line 182 of file MCGIDI_map.cc.

                                                                        {
 
    MCGIDI_mapEntry *entry, *next;
 
    if( map->path != NULL ) smr_freeMemory( (void **) &(map->path) );
    for( entry = map->mapEntries; entry != NULL; entry = next ) {
        next = entry->next;
        if( entry->schema != NULL ) smr_freeMemory( (void **) &(entry->schema) );
        if( entry->path != NULL ) smr_freeMemory( (void **) &(entry->path) );
        if( entry->evaluation != NULL ) smr_freeMemory( (void **) &(entry->evaluation) );
        if( entry->projectile != NULL ) smr_freeMemory( (void **) &(entry->projectile) );
        if( entry->targetName != NULL ) smr_freeMemory( (void **) &(entry->targetName) );
        if( entry->map != NULL ) MCGIDI_map_free( smr, entry->map );
        smr_freeMemory( (void **) &entry );
    }
    map->numberOfEntries = 0;
    map->mapEntries = NULL;
    map->status = MCGIDI_map_status_Ok;
}

Referenced by MCGIDI_map_free().

MCGIDI_map_simpleWrite()

void MCGIDI_map_simpleWrite	(	FILE *	f,
		MCGIDI_map *	map )

Definition at line 550 of file MCGIDI_map.cc.

{ _MCGIDI_map_simpleWrite2( f, map, 0 ); }

MCGIDI_map_toXMLString()

char * MCGIDI_map_toXMLString	(	statusMessageReporting *	smr,
		MCGIDI_map *	map )

Definition at line 501 of file MCGIDI_map.cc.

                                                                             {
 
    MCGIDI_mapEntry *entry;
    char *s, *p;
    char targetFormat[] = "<target schema=\"%s\" evaluation=\"%s\" projectile=\"%s\" target=\"%s\" path=\"%s\"/>\n";
    char pathFormat[] = "<path projectile=\"%s\" path=\"%s\"/>\n";
    char start[] = "<map>\n";
    char end[] = "</map>";
    int n = 0, nStart = (int) strlen( start ), nEnd = (int) strlen( end );
    int nTarget = (int) strlen( targetFormat ) - 10, nPath = (int) strlen( pathFormat ) - 4;
 
    if( map->status != MCGIDI_map_status_Ok ) return( NULL );
 
    n = nStart + nEnd + 1;
    for( entry = map->mapEntries; entry != NULL; entry = entry->next ) {
        switch( entry->type ) {
        case MCGIDI_mapEntry_type_target :
            n += (int) ( strlen( entry->schema ) + strlen( entry->path ) + strlen( entry->evaluation ) + strlen( entry->projectile ) + strlen( entry->targetName ) + nTarget );
            break;
        case MCGIDI_mapEntry_type_path :
            n += (int ) strlen( entry->path ) + (int ) strlen( entry->projectile ) + nPath;
            break;
        default :
            smr_setReportInfo3( smr, &(map->smrUserInterface), smr_unknownID, MCGIDI_map_status_UnknownType, "unknown type = %d", entry->type );
            return( NULL );
        }
    }
 
    if( ( s = (char *) smr_malloc2( smr, n, 0, "xml string" ) ) == NULL ) return( NULL );
    p = s;
    strcpy( p, start );
    while( *p ) p++; // Loop checking, 11.06.2015, T. Koi
    for( entry = map->mapEntries; entry != NULL; entry = entry->next ) {
        switch( entry->type ) {
        case MCGIDI_mapEntry_type_target :
            snprintf( p, sizeof start, targetFormat, entry->schema, entry->evaluation, entry->projectile, entry->targetName, entry->path );
            break;
        case MCGIDI_mapEntry_type_path :
            snprintf( p, sizeof start, pathFormat, entry->projectile, entry->path );
            break;
        }
        while( *p ) p++; // Loop checking, 11.06.2015, T. Koi
    }
    strcpy( p, end );
    return( s );
}

MCGIDI_map_walkTree()

int MCGIDI_map_walkTree	(	statusMessageReporting *	smr,
		MCGIDI_map *	map,
		int(*	handler )(MCGIDI_mapEntry *entry, int level, void *userData),
		void *	userData )

Definition at line 494 of file MCGIDI_map.cc.

                                                                                                                                                            {
 
    return( _MCGIDI_map_walkTree2( smr, map, 0, handler, userData ) );
}

Referenced by G4GIDI::getNamesOfAvailableTargets().