OOSystemDescriptionManager Class Reference

#include <OOSystemDescriptionManager.h>

Inheritance diagram for OOSystemDescriptionManager:

Collaboration diagram for OOSystemDescriptionManager:

Instance Methods
(void)	- buildRouteCache
(void)	- setUniversalProperties:
(void)	- setInterstellarProperties:
(void)	- setProperties:forSystemKey:
(void)	- setProperty:forSystemKey:andLayer:toValue:fromManifest:
(void)	- importScriptedChanges:
(void)	- importLegacyScriptedChanges:
(NSDictionary *)	- exportScriptedChanges
(NSDictionary *)	- getPropertiesForSystemKey:
(NSDictionary *)	- getPropertiesForSystem:inGalaxy:
(NSDictionary *)	- getPropertiesForCurrentSystem
(id)	- getProperty:forSystemKey:
(id)	- getProperty:forSystem:inGalaxy:
(NSPoint)	- getCoordinatesForSystem:inGalaxy:
(NSArray *)	- getNeighbourIDsForSystem:inGalaxy:
(Random_Seed)	- getRandomSeedForCurrentSystem
(Random_Seed)	- getRandomSeedForSystem:inGalaxy:
(id)	- init [implementation]
(void)	- dealloc [implementation]
(void)	- saveScriptedChangeToProperty:forSystemKey:andLayer:toValue:fromManifest: [implementation]
(id)	- getProperty:forSystemKey:withUniversal: [implementation]
(id)	- getProperty:orProperty:forSystemKey:withUniversal: [implementation]
(void)	- setProperties:inDescription: [implementation]
(NSDictionary *)	- calculatePropertiesForSystemKey: [implementation]
(void)	- updateCacheEntry: [implementation]
(void)	- updateCacheEntry:forProperty: [implementation]

Private Attributes
NSMutableDictionary *	universalProperties
OOSystemDescriptionEntry *	interstellarSpace
NSMutableDictionary *	systemDescriptions
NSMutableDictionary *	propertyCache [OO_SYSTEM_CACHE_LENGTH]
NSMutableSet *	propertiesInUse
NSPoint	coordinatesCache [OO_SYSTEM_CACHE_LENGTH]
NSMutableArray *	neighbourCache [OO_SYSTEM_CACHE_LENGTH]
NSMutableDictionary *	scriptedChanges

Detailed Description

Note: forSystem: inGalaxy: returns from the (fast) propertyCache

forSystemKey calculates the values - but is necessary for interstellar space

Definition at line 73 of file OOSystemDescriptionManager.h.

Method Documentation

buildRouteCache

- (void) buildRouteCache

Definition at line 100 of file OOSystemDescriptionManager.m.

{
    NSUInteger i,j,k,jIndex,kIndex;
    // firstly, cache all coordinates
    for (i=0;i<OO_SYSTEM_CACHE_LENGTH;i++)
    {
        coordinatesCache[i] = PointFromString([propertyCache[i] oo_stringForKey:@"coordinates"]);
    }
    // now for each system find its neighbours
    for (i=0;i<OO_GALAXIES_AVAILABLE;i++)
    {
        // one galaxy at a time
        for (j=0;j<OO_SYSTEMS_PER_GALAXY;j++)
        {
            jIndex = j+(i*OO_SYSTEMS_PER_GALAXY);
            for (k=j+1;k<OO_SYSTEMS_PER_GALAXY;k++)
            {
                kIndex = k+(i*OO_SYSTEMS_PER_GALAXY);
                if (distanceBetweenPlanetPositions(coordinatesCache[jIndex].x,coordinatesCache[jIndex].y,coordinatesCache[kIndex].x,coordinatesCache[kIndex].y) <= MAX_JUMP_RANGE)
                {
                    // arrays are of system number only
                    [neighbourCache[jIndex] addObject:[NSNumber numberWithUnsignedInteger:k]];
                    [neighbourCache[kIndex] addObject:[NSNumber numberWithUnsignedInteger:j]];
                }
            }
        }
    }
 
}

References buildRouteCache, coordinatesCache, distanceBetweenPlanetPositions(), MAX_JUMP_RANGE, OO_GALAXIES_AVAILABLE, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, PointFromString(), propertyCache, x, and y.

Referenced by buildRouteCache, and ResourceManager::systemDescriptionManager.

Here is the call graph for this function:

Here is the caller graph for this function:

calculatePropertiesForSystemKey:

- (NSDictionary *) calculatePropertiesForSystemKey: (NSString *) key

implementation

Provided by category OOSystemDescriptionManager(OOPrivate).

Definition at line 503 of file OOSystemDescriptionManager.m.

                                                  :(NSString *)key
{
    NSMutableDictionary *dict = [NSMutableDictionary dictionaryWithCapacity:OO_LIKELY_PROPERTIES_PER_SYSTEM];
    NSString *property = nil;
    id val = nil;
    BOOL interstellar = [key hasPrefix:@"interstellar:"];
    foreach (property, propertiesInUse)
    {
        // don't use universal properties on interstellar specific regions
        val = [self getProperty:property forSystemKey:key withUniversal:!interstellar];
 
        if (val != nil)
        {
            [dict setObject:val forKey:property];
        }
        else if (interstellar)
        {
            // interstellar is always overridden by specific regions
            // universal properties for interstellar get picked up here
            val = [self getProperty:property forSystemKey:@"interstellar"];
            if (val != nil)
            {
                [dict setObject:val forKey:property];
            }
        }
    }
    return dict;
}

References getProperty:forSystemKey:, getProperty:forSystemKey:withUniversal:, and nil.

Referenced by getPropertiesForSystemKey:, and OOSystemDescriptionManager(OOPrivate)::updateCacheEntry:.

Here is the call graph for this function:

Here is the caller graph for this function:

dealloc

- (void) dealloc

implementation

Definition at line 84 of file OOSystemDescriptionManager.m.

{
    DESTROY(universalProperties);
    DESTROY(interstellarSpace);
    DESTROY(systemDescriptions);
    for (NSUInteger i=0;i<OO_SYSTEM_CACHE_LENGTH;i++)
    {
        DESTROY(propertyCache[i]);
        DESTROY(neighbourCache[i]);
    }
    DESTROY(propertiesInUse);
    DESTROY(scriptedChanges);
    [super dealloc];
}

References dealloc, DESTROY, interstellarSpace, neighbourCache, OO_SYSTEM_CACHE_LENGTH, propertiesInUse, propertyCache, scriptedChanges, systemDescriptions, and universalProperties.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

exportScriptedChanges

- (NSDictionary *) exportScriptedChanges

Definition at line 312 of file OOSystemDescriptionManager.m.

{
    return [[scriptedChanges copy] autorelease];
}

References exportScriptedChanges.

Referenced by exportScriptedChanges.

Here is the call graph for this function:

Here is the caller graph for this function:

getCoordinatesForSystem:inGalaxy:

- (NSPoint) getCoordinatesForSystem:		(OOSystemID)	s
inGalaxy:		(OOGalaxyID)	g

Definition at line 560 of file OOSystemDescriptionManager.m.

                                   :(OOSystemID)s inGalaxy:(OOGalaxyID)g
{
    if (s < 0)
    {
        OOLog(@"system.description.error",@"'%d %d' is an invalid system key. This is an internal error. Please report it.",g,s);
        return (NSPoint){0,0};
    }
    NSUInteger index = (g * OO_SYSTEMS_PER_GALAXY) + s;
    if (index >= OO_SYSTEM_CACHE_LENGTH)
    {
        OOLog(@"system.description.error",@"'%d %d' is an invalid system key. This is an internal error. Please report it.",g,s);
        return (NSPoint){0,0};
    }
    return coordinatesCache[index];
}

References coordinatesCache, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, and OOLog.

Referenced by Universe::coordinatesForSystem:, GuiDisplayGen(Internal)::drawAdvancedNavArrayAtX:y:z:alpha:usingRoute:optimizedBy:zoom:, GuiDisplayGen(Internal)::drawStarChart:x:y:z:alpha:, Universe::findConnectedSystemAtCoords:withGalaxy:, Universe::findNeighbouringSystemToCoords:withGalaxy:, Universe::findSystemCoordinatesWithPrefix:exactMatch:, Universe::findSystemNumberAtCoords:withGalaxy:includingHidden:, and Universe::routeFromSystem:toSystem:optimizedBy:.

Here is the caller graph for this function:

getNeighbourIDsForSystem:inGalaxy:

- (NSArray *) getNeighbourIDsForSystem:		(OOSystemID)	s
inGalaxy:		(OOGalaxyID)	g

Definition at line 577 of file OOSystemDescriptionManager.m.

                                      :(OOSystemID)s inGalaxy:(OOGalaxyID)g
{
    if (s < 0)
    {
        OOLog(@"system.description.error",@"'%d %d' is an invalid system key. This is an internal error. Please report it.",g,s);
        return nil;
    }
    NSUInteger index = (g * OO_SYSTEMS_PER_GALAXY) + s;
    if (index >= OO_SYSTEM_CACHE_LENGTH)
    {
        OOLog(@"system.description.error",@"'%d %d' is an invalid system key. This is an internal error. Please report it.",g,s);
        return nil;
    }
 
    return neighbourCache[index];
}

References neighbourCache, nil, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, and OOLog.

Referenced by Universe::neighboursToSystem:.

Here is the caller graph for this function:

getPropertiesForCurrentSystem

- (NSDictionary *) getPropertiesForCurrentSystem

Definition at line 318 of file OOSystemDescriptionManager.m.

{
    OOSystemID s = [UNIVERSE currentSystemID];
    if (s >= 0)
    {
        NSUInteger index = ([PLAYER galaxyNumber] * OO_SYSTEMS_PER_GALAXY) + s;
        if (index >= OO_SYSTEM_CACHE_LENGTH)
        {
            OOLog(@"system.description.error",@"'%lu' is an invalid system index for the current system. This is an internal error. Please report it.",index);
            return [NSDictionary dictionary];
        }
        return propertyCache[index];
    }
    else
    {
        OOLog(@"system.description.error", @"%@", @"getPropertiesForCurrentSystem called while player in interstellar space. This is an internal error. Please report it.");
        // this shouldn't be called for interstellar space
        return [NSDictionary dictionary];
    }
}

References getPropertiesForCurrentSystem, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, OOLog, and propertyCache.

Referenced by getPropertiesForCurrentSystem, Universe::populateNormalSpace, Universe::setSystemDataForGalaxy:planet:key:value:fromManifest:forLayer:, Universe::setUpPlanet, and Universe::setUpSpace.

Here is the call graph for this function:

Here is the caller graph for this function:

getPropertiesForSystem:inGalaxy:

- (NSDictionary *) getPropertiesForSystem:		(OOSystemID)	s
inGalaxy:		(OOGalaxyID)	g

Definition at line 360 of file OOSystemDescriptionManager.m.

                                         :(OOSystemID)s inGalaxy:(OOGalaxyID)g
{
    NSUInteger index = (g * OO_SYSTEMS_PER_GALAXY) + s;
    if (index >= OO_SYSTEM_CACHE_LENGTH)
    {
        OOLog(@"system.description.error",@"'%u, %u' is an invalid system. This is an internal error. Please report it.",g,s);
        return [NSDictionary dictionary];
    }
    return propertyCache[index];
}

References OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, OOLog, and propertyCache.

Referenced by GuiDisplayGen(Internal)::drawAdvancedNavArrayAtX:y:z:alpha:usingRoute:optimizedBy:zoom:, GuiDisplayGen(Internal)::drawStarChart:x:y:z:alpha:, Universe::findSystemCoordinatesWithPrefix:exactMatch:, Universe::findSystemNumberAtCoords:withGalaxy:includingHidden:, and Universe::routeFromSystem:toSystem:optimizedBy:.

Here is the caller graph for this function:

getPropertiesForSystemKey:

- (NSDictionary *) getPropertiesForSystemKey:

(NSString *)

key

Definition at line 340 of file OOSystemDescriptionManager.m.

                                            :(NSString *)key
{
    NSArray  *tokens = ScanTokensFromString(key);
    if ([tokens count] == 2 && [tokens oo_unsignedIntegerAtIndex:0] < OO_GALAXIES_AVAILABLE && [tokens oo_unsignedIntegerAtIndex:1] < OO_SYSTEMS_PER_GALAXY)
    {
        OOGalaxyID g = [tokens oo_unsignedIntegerAtIndex:0];
        OOSystemID s = [tokens oo_unsignedIntegerAtIndex:1];
        NSUInteger index = (g * OO_SYSTEMS_PER_GALAXY) + s;
        if (index >= OO_SYSTEM_CACHE_LENGTH)
        {
            OOLog(@"system.description.error",@"'%@' is an invalid system key. This is an internal error. Please report it.",key);
            return [NSDictionary dictionary];
        }
        return propertyCache[index];
    }
    // interstellar spaces aren't cached
    return [self calculatePropertiesForSystemKey:key];
}

References calculatePropertiesForSystemKey:, count, OO_GALAXIES_AVAILABLE, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, OOLog, propertyCache, and ScanTokensFromString().

Referenced by Universe::generateSystemData:useCache:, Universe::generateSystemDataForGalaxy:planet:, and Universe::setUpWitchspaceBetweenSystem:andSystem:.

Here is the call graph for this function:

Here is the caller graph for this function:

getProperty:forSystem:inGalaxy:

- (id) getProperty:		(NSString *)	property
forSystem:		(OOSystemID)	s
inGalaxy:		(OOGalaxyID)	g

Definition at line 377 of file OOSystemDescriptionManager.m.

                  :(NSString *)property forSystem:(OOSystemID)s inGalaxy:(OOGalaxyID)g
{
    if (s < 0)
    {
        OOLog(@"system.description.error",@"'%d %d' is an invalid system key. This is an internal error. Please report it.",g,s);
        return nil;
    }
    NSUInteger index = (g * OO_SYSTEMS_PER_GALAXY) + s;
    if (index >= OO_SYSTEM_CACHE_LENGTH)
    {
        OOLog(@"system.description.error",@"'%d %d' is an invalid system key. This is an internal error. Please report it.",g,s);
        return nil;
    }
    return [propertyCache[index] objectForKey:property];
}

References nil, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, and OOLog.

Referenced by Universe::getSystemGovernment:, Universe::getSystemInhabitants:plural:, Universe::getSystemName:forGalaxy:, Universe::setGalaxyTo:andReinit:, Universe::systemDataForGalaxy:planet:key:, and SystemInfoGetProperty().

Here is the caller graph for this function:

getProperty:forSystemKey:

- (id) getProperty:		(NSString *)	property
forSystemKey:		(NSString *)	key

Definition at line 372 of file OOSystemDescriptionManager.m.

                  :(NSString *)property forSystemKey:(NSString *)key
{
    return [self getProperty:property forSystemKey:key withUniversal:YES];
}

References getProperty:forSystemKey:withUniversal:.

Referenced by OOSystemDescriptionManager(OOPrivate)::calculatePropertiesForSystemKey:, GuiDisplayGen(Internal)::drawAdvancedNavArrayAtX:y:z:alpha:usingRoute:optimizedBy:zoom:, importLegacyScriptedChanges:, and OOSystemDescriptionManager(OOPrivate)::updateCacheEntry:forProperty:.

Here is the call graph for this function:

Here is the caller graph for this function:

getProperty:forSystemKey:withUniversal:

- (id) getProperty: (NSString *) property forSystemKey: (NSString *) key withUniversal: (BOOL) universal

implementation

Provided by category OOSystemDescriptionManager(OOPrivate).

Definition at line 394 of file OOSystemDescriptionManager.m.

                  :(NSString *)property forSystemKey:(NSString *)key withUniversal:(BOOL)universal
{
    OOSystemDescriptionEntry *desc = nil;
    if (EXPECT_NOT([key isEqualToString:@"interstellar"]))
    {
        desc = interstellarSpace;
    }
    else
    {
        desc = [systemDescriptions objectForKey:key];
    }
    if (desc == nil)
    {
        return nil;
    }
    id result = nil;
    result = [desc getProperty:property forLayer:OO_LAYER_OXP_PRIORITY];
    if (result == nil)
    {
        result = [desc getProperty:property forLayer:OO_LAYER_OXP_DYNAMIC];
    }
    if (result == nil)
    {
        result = [desc getProperty:property forLayer:OO_LAYER_OXP_STATIC];
    }
    if (result == nil && universal)
    {
        result = [universalProperties objectForKey:property];
    }
    if (result == nil)
    {
        result = [desc getProperty:property forLayer:OO_LAYER_CORE];
    }
    return result;
}

References EXPECT_NOT, OOSystemDescriptionEntry::getProperty:forLayer:, and nil.

Referenced by OOSystemDescriptionManager(OOPrivate)::calculatePropertiesForSystemKey:, and getProperty:forSystemKey:.

Here is the call graph for this function:

Here is the caller graph for this function:

getProperty:orProperty:forSystemKey:withUniversal:

- (id) getProperty: (NSString *) property1 orProperty: (NSString *) property2 forSystemKey: (NSString *) key withUniversal: (BOOL) universal

implementation

Provided by category OOSystemDescriptionManager(OOPrivate).

Definition at line 431 of file OOSystemDescriptionManager.m.

                  :(NSString *)property1 orProperty:(NSString *)property2 forSystemKey:(NSString *)key withUniversal:(BOOL)universal
{
    OOSystemDescriptionEntry *desc = [systemDescriptions objectForKey:key];
    if (desc == nil)
    {
        return nil;
    }
    id result = nil;
    result = [desc getProperty:property1 forLayer:OO_LAYER_OXP_PRIORITY];
    if (result == nil)
    {
        result = [desc getProperty:property2 forLayer:OO_LAYER_OXP_PRIORITY];
    }
    if (result == nil)
    {
        result = [desc getProperty:property1 forLayer:OO_LAYER_OXP_DYNAMIC];
    }
    if (result == nil)
    {
        result = [desc getProperty:property2 forLayer:OO_LAYER_OXP_DYNAMIC];
    }
    if (result == nil)
    {
        result = [desc getProperty:property1 forLayer:OO_LAYER_OXP_STATIC];
    }
    if (result == nil)
    {
        result = [desc getProperty:property2 forLayer:OO_LAYER_OXP_STATIC];
    }
    if (universal)
    {
        if (result == nil)
        {
            result = [universalProperties objectForKey:property1];
        }
        if (result == nil)
        {
            result = [universalProperties objectForKey:property2];
        }
    }
    if (result == nil)
    {
        result = [desc getProperty:property1 forLayer:OO_LAYER_CORE];
    }
    if (result == nil)
    {
        result = [desc getProperty:property2 forLayer:OO_LAYER_CORE];
    }
    return result;
}

References OOSystemDescriptionEntry::getProperty:forLayer:, and nil.

Here is the call graph for this function:

getRandomSeedForCurrentSystem

- (Random_Seed) getRandomSeedForCurrentSystem

Definition at line 595 of file OOSystemDescriptionManager.m.

{
    if ([UNIVERSE currentSystemID] < 0)
    {
        return kNilRandomSeed;
    }
    else
    {
        OOSystemID s = [UNIVERSE currentSystemID];
        NSUInteger index = ([PLAYER galaxyNumber] * OO_SYSTEMS_PER_GALAXY) + s;
        if (index >= OO_SYSTEM_CACHE_LENGTH)
        {
            OOLog(@"system.description.error",@"'%lu' is an invalid system index for the current system. This is an internal error. Please report it.",(unsigned long)index);
            return kNilRandomSeed;
        }
        return RandomSeedFromString([propertyCache[index] oo_stringForKey:@"random_seed"]);
    }
}

References getRandomSeedForCurrentSystem, kNilRandomSeed, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, OOLog, propertyCache, RandomSeedFromString(), and UNIVERSE.

Referenced by getRandomSeedForCurrentSystem, Universe::marketSeed, Universe::populateSystemFromDictionariesWithSun:andPlanet:, Universe::setUpPlanet, and Universe::setUpSpace.

Here is the call graph for this function:

Here is the caller graph for this function:

getRandomSeedForSystem:inGalaxy:

- (Random_Seed) getRandomSeedForSystem:		(OOSystemID)	s
inGalaxy:		(OOGalaxyID)	g

Definition at line 615 of file OOSystemDescriptionManager.m.

                                      :(OOSystemID)s inGalaxy:(OOGalaxyID)g
{
    if (s < 0)
    {
        OOLog(@"system.description.error",@"'%d %d' is an invalid system key. This is an internal error. Please report it.",g,s);
        return kNilRandomSeed;
    }
    NSUInteger index = (g * OO_SYSTEMS_PER_GALAXY) + s;
    if (index >= OO_SYSTEM_CACHE_LENGTH)
    {
        OOLog(@"system.description.error",@"'%d %d' is an invalid system key. This is an internal error. Please report it.",g,s);
        return kNilRandomSeed;
    }
    return RandomSeedFromString([propertyCache[index] oo_stringForKey:@"random_seed"]);
}

References kNilRandomSeed, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, OOLog, propertyCache, and RandomSeedFromString().

Here is the call graph for this function:

importLegacyScriptedChanges:

- (void) importLegacyScriptedChanges:

(NSDictionary *)

scripted

Definition at line 273 of file OOSystemDescriptionManager.m.

                                    :(NSDictionary *)scripted
{
    NSString *systemKey = nil;
    NSString *propertyKey = nil;
    NSString *defaultManifest = @"org.oolite.oolite";
    
    foreachkey(systemKey,scripted)
    {
        NSDictionary *legacyChanges = [scripted oo_dictionaryForKey:systemKey];
        if ([legacyChanges objectForKey:@"sun_gone_nova"] != nil)
        {
            // then this is a change to import even if we don't know
            // if the OXP is still installed
            foreachkey (propertyKey, legacyChanges)
            {
                [self setProperty:propertyKey
                     forSystemKey:systemKey
                         andLayer:OO_LAYER_OXP_DYNAMIC
                          toValue:[legacyChanges objectForKey:propertyKey]
                     fromManifest:defaultManifest];
            }
            /* Fix for older savegames not having a larger sun radius
             * property set from the Nova mission. */
            id sr = [self getProperty:@"sun_radius" forSystemKey:systemKey];
            float sr_num = [sr floatValue];
            if (sr_num < 600000) {
                // fix sun radius values
                [self setProperty:@"sun_radius"
                     forSystemKey:systemKey
                         andLayer:OO_LAYER_OXP_DYNAMIC
                          toValue:[NSNumber numberWithFloat:sr_num+600000.0f]
                     fromManifest:defaultManifest];
            }
        }
    }
 
}

References foreachkey, getProperty:forSystemKey:, nil, and setProperty:forSystemKey:andLayer:toValue:fromManifest:.

Here is the call graph for this function:

importScriptedChanges:

- (void) importScriptedChanges:

(NSDictionary *)

scripted

Definition at line 238 of file OOSystemDescriptionManager.m.

                              :(NSDictionary *)scripted
{
    NSArray *key = nil;
    NSString *keyStr = nil;
    NSString *manifest = nil;
    foreachkey(keyStr, scripted)
    {
        key = [keyStr componentsSeparatedByString:kOOScriptedChangeJoiner];
        if ([key count] == 4)
        {
            manifest = [key oo_stringAtIndex:0];
            if ([ResourceManager manifestForIdentifier:manifest] != nil)
            {
//              OOLog(@"importing",@"%@ -> %@",keyStr,[scripted objectForKey:keyStr]);
                [self setProperty:[key oo_stringAtIndex:2]
                     forSystemKey:[key oo_stringAtIndex:1]
                         andLayer:[key oo_intAtIndex:3]
                          toValue:[scripted objectForKey:keyStr]
                     fromManifest:manifest];
                // and doing this set stores it into the manager's copy
                // of scripted changes
                // this means in theory we could import more than one
            }
            // else OXP not installed, do not load
        }
        else
        {
            OOLog(@"systemManager.import",@"Key '%@' has unexpected format - skipping",keyStr);
        }
    }
 
}

References count, foreachkey, nil, OOLog, and setProperty:forSystemKey:andLayer:toValue:fromManifest:.

Here is the call graph for this function:

init

- (id) init

implementation

Definition at line 62 of file OOSystemDescriptionManager.m.

{
    self = [super init];
    if (self != nil)
    {
        universalProperties = [[NSMutableDictionary alloc] initWithCapacity:OO_LIKELY_PROPERTIES_PER_SYSTEM];
        interstellarSpace = [[OOSystemDescriptionEntry alloc] init];
        // assume specific interstellar settings are rare
        systemDescriptions = [[NSMutableDictionary alloc] initWithCapacity:OO_SYSTEM_CACHE_LENGTH+20];
        for (NSUInteger i=0;i<OO_SYSTEM_CACHE_LENGTH;i++)
        {
            propertyCache[i] = [[NSMutableDictionary alloc] initWithCapacity:OO_LIKELY_PROPERTIES_PER_SYSTEM];
            // hub count of 24 is considerably higher than occurs in
            // standard planetinfo
            neighbourCache[i] = [[NSMutableArray alloc] initWithCapacity:24];
        }
        propertiesInUse = [[NSMutableSet alloc] initWithCapacity:OO_LIKELY_PROPERTIES_PER_SYSTEM];
        scriptedChanges = [[NSMutableDictionary alloc] initWithCapacity:64];
    }
    return self;
}

References init, interstellarSpace, neighbourCache, nil, OO_SYSTEM_CACHE_LENGTH, propertiesInUse, propertyCache, scriptedChanges, systemDescriptions, and universalProperties.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

saveScriptedChangeToProperty:forSystemKey:andLayer:toValue:fromManifest:

- (void) saveScriptedChangeToProperty: (NSString *) property forSystemKey: (NSString *) key andLayer: (OOSystemLayer) layer toValue: (id) value fromManifest: (NSString *) manifest

implementation

Provided by category OOSystemDescriptionManager(OOPrivate).

Definition at line 215 of file OOSystemDescriptionManager.m.

                                     :(NSString *)property forSystemKey:(NSString *)key andLayer:(OOSystemLayer)layer toValue:(id)value fromManifest:(NSString *)manifest
{
    // if OXP doesn't have a manifest, cancel saving the change
    if (manifest == nil)
    {
        return;
    }
//  OOLog(@"saving change",@"%@ %@ %@ %d",manifest,key,property,layer);
    NSArray *overrideKey = [NSArray arrayWithObjects:manifest,key,property,[[NSNumber numberWithInt:layer] stringValue],nil];
    // Obj-C copes with NSArray keys to dictionaries fine, but the
    // plist format doesn't, so they can't be saved.
    NSString *overrideKeyStr = [overrideKey componentsJoinedByString:kOOScriptedChangeJoiner];
    if (value != nil)
    {
        [scriptedChanges setObject:value forKey:overrideKeyStr];
    }
    else
    {
        [scriptedChanges removeObjectForKey:overrideKeyStr];
    }
}

References nil.

Referenced by setProperty:forSystemKey:andLayer:toValue:fromManifest:.

Here is the caller graph for this function:

setInterstellarProperties:

- (void) setInterstellarProperties:

(NSDictionary *)

properties

Definition at line 142 of file OOSystemDescriptionManager.m.

                                  :(NSDictionary *)properties
{
    [self setProperties:properties inDescription:interstellarSpace];
}

References setProperties:inDescription:.

Referenced by ResourceManager::systemDescriptionManager.

Here is the call graph for this function:

Here is the caller graph for this function:

setProperties:forSystemKey:

- (void) setProperties:		(NSDictionary *)	properties
forSystemKey:		(NSString *)	key

Definition at line 148 of file OOSystemDescriptionManager.m.

                      :(NSDictionary *)properties forSystemKey:(NSString *)key
{
    OOSystemDescriptionEntry *desc = [systemDescriptions objectForKey:key];
    if (desc == nil)
    {
        // create it
        desc = [[[OOSystemDescriptionEntry alloc] init] autorelease];
        [systemDescriptions setObject:desc forKey:key];
    }
    [self setProperties:properties inDescription:desc];
    [propertiesInUse addObjectsFromArray:[properties allKeys]];
 
    NSArray  *tokens = ScanTokensFromString(key);
    if ([tokens count] == 2 && [tokens oo_unsignedIntegerAtIndex:0] < OO_GALAXIES_AVAILABLE && [tokens oo_unsignedIntegerAtIndex:1] < OO_SYSTEMS_PER_GALAXY)
    {
        OOGalaxyID g = [tokens oo_unsignedIntegerAtIndex:0];
        OOSystemID s = [tokens oo_unsignedIntegerAtIndex:1];
        NSUInteger index = (g * OO_SYSTEMS_PER_GALAXY) + s;
        if (index >= OO_SYSTEM_CACHE_LENGTH)
        {
            OOLog(@"system.description.error",@"'%@' is an invalid system key. This is an internal error. Please report it.",key);
        }
        else
        {
            [self updateCacheEntry:index];
        }
    }
}

References count, nil, OO_GALAXIES_AVAILABLE, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, OOLog, ScanTokensFromString(), setProperties:inDescription:, and updateCacheEntry:.

Referenced by ResourceManager::systemDescriptionManager.

Here is the call graph for this function:

Here is the caller graph for this function:

setProperties:inDescription:

- (void) setProperties: (NSDictionary *) properties inDescription: (OOSystemDescriptionEntry *) desc

implementation

Provided by category OOSystemDescriptionManager(OOPrivate).

Definition at line 483 of file OOSystemDescriptionManager.m.

                      :(NSDictionary *)properties inDescription:(OOSystemDescriptionEntry *)desc
{
    OOSystemLayer layer = [properties oo_unsignedIntForKey:kOOSystemLayerProperty defaultValue:OO_LAYER_OXP_STATIC];
    if (layer > OO_LAYER_OXP_PRIORITY)
    {
        OOLog(@"system.description.error",@"Layer %u is not a valid layer number in system information.",layer);
        layer = OO_LAYER_OXP_PRIORITY;
    }
    NSString *key = nil;
    foreachkey(key, properties)
    {
        if (![key isEqualToString:kOOSystemLayerProperty])
        {
            [propertiesInUse addObject:key];
            [desc setProperty:key forLayer:layer toValue:[properties objectForKey:key]];
        }
    }
}

References foreachkey, kOOSystemLayerProperty, nil, OO_LAYER_OXP_PRIORITY, OOLog, and OOSystemDescriptionEntry::setProperty:forLayer:toValue:.

Referenced by setInterstellarProperties:, and setProperties:forSystemKey:.

Here is the call graph for this function:

Here is the caller graph for this function:

setProperty:forSystemKey:andLayer:toValue:fromManifest:

- (void) setProperty:		(NSString *)	property
forSystemKey:		(NSString *)	key
andLayer:		(OOSystemLayer)	layer
toValue:		(id)	value
fromManifest:		(NSString *)	manifest

Definition at line 178 of file OOSystemDescriptionManager.m.

                    :(NSString *)property forSystemKey:(NSString *)key andLayer:(OOSystemLayer)layer toValue:(id)value fromManifest:(NSString *)manifest
{
    OOSystemDescriptionEntry *desc = [systemDescriptions objectForKey:key];
    if (desc == nil)
    {
        // create it
        desc = [[[OOSystemDescriptionEntry alloc] init] autorelease];
        [systemDescriptions setObject:desc forKey:key];
    }
    [desc setProperty:property forLayer:layer toValue:value];
    [propertiesInUse addObject:property];
 
    NSArray  *tokens = ScanTokensFromString(key);
    if ([tokens count] == 2 && [tokens oo_unsignedIntegerAtIndex:0] < OO_GALAXIES_AVAILABLE && [tokens oo_unsignedIntegerAtIndex:1] < OO_SYSTEMS_PER_GALAXY)
    {
        [self saveScriptedChangeToProperty:property forSystemKey:key andLayer:layer toValue:value fromManifest:manifest];
    
        OOGalaxyID g = [tokens oo_unsignedIntegerAtIndex:0];
        OOSystemID s = [tokens oo_unsignedIntegerAtIndex:1];
        NSUInteger index = (g * OO_SYSTEMS_PER_GALAXY) + s;
        if (index >= OO_SYSTEM_CACHE_LENGTH)
        {
            OOLog(@"system.description.error",@"'%@' is an invalid system key. This is an internal error. Please report it.",key);
        }
        else
        {
            [self updateCacheEntry:index forProperty:property];
        }
    }
    // for interstellar updates, save but don't update cache
    else if ([tokens count] == 4 && [tokens oo_unsignedIntegerAtIndex:1] < OO_GALAXIES_AVAILABLE && [tokens oo_unsignedIntegerAtIndex:2] < OO_SYSTEMS_PER_GALAXY && [tokens oo_unsignedIntegerAtIndex:3] < OO_SYSTEMS_PER_GALAXY)
    {
        [self saveScriptedChangeToProperty:property forSystemKey:key andLayer:layer toValue:value fromManifest:manifest];
    }
}

References count, nil, OO_GALAXIES_AVAILABLE, OO_SYSTEM_CACHE_LENGTH, OO_SYSTEMS_PER_GALAXY, OOLog, saveScriptedChangeToProperty:forSystemKey:andLayer:toValue:fromManifest:, ScanTokensFromString(), OOSystemDescriptionEntry::setProperty:forLayer:toValue:, and updateCacheEntry:forProperty:.

Referenced by importLegacyScriptedChanges:, importScriptedChanges:, and Universe::setSystemDataForGalaxy:planet:key:value:fromManifest:forLayer:.

Here is the call graph for this function:

Here is the caller graph for this function:

setUniversalProperties:

- (void) setUniversalProperties:

(NSDictionary *)

properties

Definition at line 131 of file OOSystemDescriptionManager.m.

                               :(NSDictionary *)properties
{
    [universalProperties addEntriesFromDictionary:properties];
    [propertiesInUse addObjectsFromArray:[properties allKeys]];
    for (NSUInteger i = 0; i<OO_SYSTEM_CACHE_LENGTH; i++)
    {
        [self updateCacheEntry:i];
    }
}

References OO_SYSTEM_CACHE_LENGTH, and updateCacheEntry:.

Referenced by ResourceManager::systemDescriptionManager.

Here is the call graph for this function:

Here is the caller graph for this function:

updateCacheEntry:

- (void) updateCacheEntry: (NSUInteger) i

implementation

Provided by category OOSystemDescriptionManager(OOPrivate).

Definition at line 533 of file OOSystemDescriptionManager.m.

                         :(NSUInteger)i
{
    NSAssert(i < OO_SYSTEM_CACHE_LENGTH,@"Invalid cache entry number");
    NSString *key = [NSString stringWithFormat:@"%lu %lu",i/OO_SYSTEMS_PER_GALAXY,i%OO_SYSTEMS_PER_GALAXY];
    NSDictionary *current = [self calculatePropertiesForSystemKey:key];
 
    [propertyCache[i] removeAllObjects];
    [propertyCache[i] addEntriesFromDictionary:current];
}

References calculatePropertiesForSystemKey:, and OO_SYSTEM_CACHE_LENGTH.

Referenced by setProperties:forSystemKey:, and setUniversalProperties:.

Here is the call graph for this function:

Here is the caller graph for this function:

updateCacheEntry:forProperty:

- (void) updateCacheEntry: (NSUInteger) i forProperty: (NSString *) property

implementation

Provided by category OOSystemDescriptionManager(OOPrivate).

Definition at line 544 of file OOSystemDescriptionManager.m.

                         :(NSUInteger)i forProperty:(NSString *)property
{
    NSAssert(i < OO_SYSTEM_CACHE_LENGTH,@"Invalid cache entry number");
    NSString *key = [NSString stringWithFormat:@"%lu %lu",i/OO_SYSTEMS_PER_GALAXY,i%OO_SYSTEMS_PER_GALAXY];
    id current = [self getProperty:property forSystemKey:key];
    if (current == nil)
    {
        [propertyCache[i] removeObjectForKey:property];
    }
    else
    {
        [propertyCache[i] setObject:current forKey:property];
    }
}

References getProperty:forSystemKey:, nil, and OO_SYSTEM_CACHE_LENGTH.

Referenced by setProperty:forSystemKey:andLayer:toValue:fromManifest:.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

coordinatesCache

- (NSPoint coordinatesCache[OO_SYSTEM_CACHE_LENGTH])

private

Definition at line 81 of file OOSystemDescriptionManager.h.

Referenced by buildRouteCache, and getCoordinatesForSystem:inGalaxy:.

interstellarSpace

- (OOSystemDescriptionEntry*) interstellarSpace

private

Definition at line 77 of file OOSystemDescriptionManager.h.

Referenced by dealloc, and init.

neighbourCache

- (NSMutableArray* neighbourCache[OO_SYSTEM_CACHE_LENGTH])

private

Definition at line 82 of file OOSystemDescriptionManager.h.

Referenced by dealloc, getNeighbourIDsForSystem:inGalaxy:, and init.

propertiesInUse

- (NSMutableSet*) propertiesInUse

private

Definition at line 80 of file OOSystemDescriptionManager.h.

Referenced by dealloc, and init.

propertyCache

- (NSMutableDictionary* propertyCache[OO_SYSTEM_CACHE_LENGTH])

private

Definition at line 79 of file OOSystemDescriptionManager.h.

Referenced by buildRouteCache, dealloc, getPropertiesForCurrentSystem, getPropertiesForSystem:inGalaxy:, getPropertiesForSystemKey:, getRandomSeedForCurrentSystem, getRandomSeedForSystem:inGalaxy:, and init.

scriptedChanges

- (NSMutableDictionary*) scriptedChanges

private

Definition at line 83 of file OOSystemDescriptionManager.h.

Referenced by dealloc, and init.

systemDescriptions

- (NSMutableDictionary*) systemDescriptions

private

Definition at line 78 of file OOSystemDescriptionManager.h.

Referenced by dealloc, and init.

universalProperties

- (NSMutableDictionary*) universalProperties

private

Definition at line 76 of file OOSystemDescriptionManager.h.

Referenced by dealloc, and init.

---

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

• src/Core/OOSystemDescriptionManager.h
• src/Core/OOSystemDescriptionManager.m