OOSystemDescriptionEntry Class Reference

#include <OOSystemDescriptionManager.h>

Inheritance diagram for OOSystemDescriptionEntry:

Collaboration diagram for OOSystemDescriptionEntry:

Instance Methods
(void)	- setProperty:forLayer:toValue:
(id)	- getProperty:forLayer:
(id)	- init [implementation]
(void)	- dealloc [implementation]
(id)	- validateProperty:withValue: [implementation]

Private Attributes
NSMutableDictionary *	layers [OO_SYSTEM_LAYERS]

Detailed Description

Definition at line 56 of file OOSystemDescriptionManager.h.

Method Documentation

dealloc

- (void) dealloc

implementation

Definition at line 58 of file OOSystemDescriptionManager.m.

{
    for (NSUInteger i=0;i<OO_SYSTEM_LAYERS;i++)
    {
        DESTROY(layers[i]);
    }
    [super dealloc];
}

getProperty:forLayer:

- (id) getProperty:		(NSString *)	property
forLayer:		(OOSystemLayer)	layer

Definition at line 58 of file OOSystemDescriptionManager.m.

                  :(NSString *)property forLayer:(OOSystemLayer)layer
{
    return [layers[layer] objectForKey:property];
}

init

- (id) init

implementation

Definition at line 58 of file OOSystemDescriptionManager.m.

{
    self = [super init];
    if (self != nil)
    {
        for (NSUInteger i=0;i<OO_SYSTEM_LAYERS;i++)
        {
            layers[i] = [[NSMutableDictionary alloc] initWithCapacity:OO_LIKELY_PROPERTIES_PER_SYSTEM];
        }
    }
    return self;
}

setProperty:forLayer:toValue:

- (void) setProperty:		(NSString *)	property
forLayer:		(OOSystemLayer)	layer
toValue:		(id)	value

Definition at line 58 of file OOSystemDescriptionManager.m.

                    :(NSString *)property forLayer:(OOSystemLayer)layer toValue:(id)value
{
    if (value == nil)
    {
        [layers[layer] removeObjectForKey:property];
    }
    else
    {
        // validate type of object for certain properties
        value = [self validateProperty:property withValue:value];
        // if it's nil now, validation failed and could not be recovered
        // so don't actually set anything
        if (value != nil)
        {
            [layers[layer] setObject:value forKey:property];
        }
    }
}

validateProperty:withValue:

- (id) validateProperty: (NSString *) property withValue: (id) value

implementation

Provided by category OOSystemDescriptionEntry(OOPrivate).

Definition at line 58 of file OOSystemDescriptionManager.m.

                       :(NSString *)property withValue:(id)value
{
    if ([property isEqualToString:@"coordinates"])
    {
        // must be a string with two numbers in it
        // TODO: convert two element arrays
        if (![value isKindOfClass:[NSString class]])
        {
            OOLog(@"system.description.error",@"'%@' is not a valid format for coordinates",value);
            return nil;
        }
        NSArray     *tokens = ScanTokensFromString((NSString *)value);
        if ([tokens count] != 2)
        {
            OOLog(@"system.description.error",@"'%@' is not a valid format for coordinates (must have exactly two numbers)",value);
            return nil;
        }
    } 
    else if ([property isEqualToString:@"radius"] || [property isEqualToString:@"government"]) 
    { 
        // read in a context which expects a string, but it's a string representation of a number
        if (![value isKindOfClass:[NSString class]])
        {
            if ([value isKindOfClass:[NSNumber class]])
            {
                return [value stringValue];
            }
            else
            {
                OOLog(@"system.description.error",@"'%@' is not a valid value for '%@' (string required)",value,property);
                return nil;
            }
        }
    }
    else if ([property isEqualToString:@"inhabitant"] || [property isEqualToString:@"inhabitants"] || [property isEqualToString:@"name"] ) 
    {
        // read in a context which expects a string
        if (![value isKindOfClass:[NSString class]])
        {
            OOLog(@"system.description.error",@"'%@' is not a valid value for '%@' (string required)",value,property);
            return nil;
        }
    }
 
    return value;
}

Member Data Documentation

layers

- (NSMutableDictionary* layers[OO_SYSTEM_LAYERS])

private

Definition at line 59 of file OOSystemDescriptionManager.h.

---

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

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