#include <OOCommodityMarket.h>

Inheritance diagram for OOCommodityMarket:

Collaboration diagram for OOCommodityMarket:

Instance Methods
(NSUInteger)	- count
(void)	- setGood:withInfo:
(NSArray *)	- goods
(NSDictionary *)	- dictionaryForScripting
(BOOL)	- setPrice:forGood:
(BOOL)	- setQuantity:forGood:
(BOOL)	- addQuantity:forGood:
(BOOL)	- removeQuantity:forGood:
(void)	- removeAllGoods
(BOOL)	- setComment:forGood:
(BOOL)	- setShortComment:forGood:
(NSString *)	- nameForGood:
(NSString *)	- commentForGood:
(NSString *)	- shortCommentForGood:
(OOCreditsQuantity)	- priceForGood:
(OOCargoQuantity)	- quantityForGood:
(OOMassUnit)	- massUnitForGood:
(NSUInteger)	- exportLegalityForGood:
(NSUInteger)	- importLegalityForGood:
(OOCargoQuantity)	- capacityForGood:
(float)	- trumbleOpinionForGood:
(NSDictionary *)	- definitionForGood:
(NSArray *)	- savePlayerAmounts
(void)	- loadPlayerAmounts:
(NSArray *)	- saveStationAmounts
(void)	- loadStationAmounts:
(id)	- init `[implementation]`
(void)	- dealloc `[implementation]`

Private Attributes
NSMutableDictionary *	_commodityList
NSArray *	_sortedKeys

Detailed Description

Definition at line 31 of file OOCommodityMarket.h.

Method Documentation

◆ addQuantity:forGood:

- (BOOL) addQuantity:		(OOCargoQuantity)	quantity
forGood:		(OOCommodityType)	good

Definition at line 112 of file OOCommodityMarket.m.

                    :(OOCargoQuantity)quantity forGood:(OOCommodityType)good
{
    OOCargoQuantity current = [self quantityForGood:good];
    if (current + quantity > [self capacityForGood:good])
    {
        return NO;
    }
    [self setQuantity:(current+quantity) forGood:good];
    return YES;
}

References quantityForGood:, and setQuantity:forGood:.

Referenced by PlayerEntity::tryBuyingCommodity:all:, PlayerEntity::trySellingCommodity:all:, and PlayerEntity::unloadAllCargoPodsForType:toManifest:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ capacityForGood:

- (OOCargoQuantity) capacityForGood: (OOCommodityType) good

Definition at line 258 of file OOCommodityMarket.m.

                                   :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return 0;
    }
    // should only be undefined for main system markets, not secondary stations
    // meaningless for player ship, though
    return [definition oo_unsignedIntForKey:kOOCommodityCapacity defaultValue:MAIN_SYSTEM_MARKET_LIMIT];
}

References nil.

Referenced by PlayerEntity::tryBuyingCommodity:all:, and PlayerEntity::trySellingCommodity:all:.

Here is the caller graph for this function:

◆ commentForGood:

- (NSString *) commentForGood: (OOCommodityType) good

Definition at line 181 of file OOCommodityMarket.m.

                             :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return OOExpand(@"[oolite-unknown-commodity-name]");
    }
    return OOExpand([definition oo_stringForKey:kOOCommodityComment defaultValue:@"[oolite-commodity-no-comment]"]);
}

References kOOCommodityComment, nil, and OOExpand.

Referenced by PlayerEntity::setGuiToMarketInfoScreen.

Here is the caller graph for this function:

◆ count

- (NSUInteger) count

Definition at line 57 of file OOCommodityMarket.m.

{
    return [_commodityList count];
}

References count.

Referenced by PlayerEntity::cargoListForScripting, count, Universe::getContainersOfGoods:scarce:legal:, savePlayerAmounts, saveStationAmounts, PlayerEntity::setGuiToMarketInfoScreen, and PlayerEntity::setGuiToMarketScreen.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dealloc

- (void) dealloc

implementation

Definition at line 49 of file OOCommodityMarket.m.

{
    DESTROY(_commodityList);
    DESTROY(_sortedKeys);
    [super dealloc];
}

References _commodityList, _sortedKeys, dealloc, and DESTROY.

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ definitionForGood:

- (NSDictionary *) definitionForGood: (OOCommodityType) good

Definition at line 282 of file OOCommodityMarket.m.

                                    :(OOCommodityType)good
{
    return [[[_commodityList oo_dictionaryForKey:good] copy] autorelease];
}

Referenced by Universe::commodityDataForType:.

Here is the caller graph for this function:

◆ dictionaryForScripting

- (NSDictionary *) dictionaryForScripting

Definition at line 82 of file OOCommodityMarket.m.

{
    return [[_commodityList copy] autorelease];
}

References dictionaryForScripting.

Referenced by dictionaryForScripting, and StationEntity::localMarketForScripting.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportLegalityForGood:

- (NSUInteger) exportLegalityForGood: (OOCommodityType) good

Definition at line 236 of file OOCommodityMarket.m.

                                    :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return 0;
    }
    return [definition oo_unsignedIntegerForKey:kOOCommodityLegalityExport];
}

References nil.

Referenced by PlayerEntity::legalStatusOfCargoList, StationEntity::legalStatusOfManifest:export:, and PlayerEntity(OOPrivate)::showMarketScreenDataLine:forGood:inMarket:holdQuantity:.

Here is the caller graph for this function:

◆ goods

- (NSArray *) goods

Definition at line 71 of file OOCommodityMarket.m.

{
    if (_sortedKeys == nil)
    {
        NSArray *keys = [_commodityList allKeys];
        _sortedKeys = [[keys sortedArrayUsingFunction:goodsSorter context:_commodityList] retain];
    }
    return _sortedKeys;
}

References _sortedKeys, goods, and nil.

Referenced by PlayerEntity::cargoListForScripting, Universe::getContainersOfGoods:scarce:legal:, goods, loadPlayerAmounts:, loadStationAmounts:, PlayerEntity(OOControlsPrivate)::pollMarketScreenControls, savePlayerAmounts, saveStationAmounts, PlayerEntity::setGuiToMarketInfoScreen, and PlayerEntity::setGuiToMarketScreen.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importLegalityForGood:

- (NSUInteger) importLegalityForGood: (OOCommodityType) good

Definition at line 247 of file OOCommodityMarket.m.

                                    :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return 0;
    }
    return [definition oo_unsignedIntegerForKey:kOOCommodityLegalityImport];
}

References nil.

Referenced by StationEntity::legalStatusOfManifest:export:, and PlayerEntity(OOPrivate)::showMarketScreenDataLine:forGood:inMarket:holdQuantity:.

Here is the caller graph for this function:

◆ init

- (id) init

implementation

Definition at line 36 of file OOCommodityMarket.m.

{
    self = [super init];
    if (self == nil)  return nil;
 
    _commodityList = [[NSMutableDictionary dictionaryWithCapacity:24] retain];
 
    _sortedKeys = nil;
 
    return self;
}

References _commodityList, _sortedKeys, init, and nil.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadPlayerAmounts:

- (void) loadPlayerAmounts: (NSArray *) amounts

Definition at line 301 of file OOCommodityMarket.m.

                          :(NSArray *)amounts
{
    OOCargoQuantity q;
    BOOL            loadedOK;
    NSString        *good = nil;
    foreach (good, [self goods])
    {
        // make sure that any goods not defined in the save game are zeroed
        [self setQuantity:0 forGood:good];
    }
 
 
    NSArray *loaded = nil;
    foreach (loaded, amounts)
    {
        loadedOK = NO;
        good = [loaded oo_stringAtIndex:0];
        q = [loaded oo_unsignedIntAtIndex:1];
        // old save games might have more in the array, but we don't care
        if (![self setQuantity:q forGood:good])
        {
            // then it's an array from a 1.80-or-earlier save game and
            // the good name is the description string (maybe a
            // translated one)
            OOCommodityType key = nil;
            foreach (key, [self goods])
            {
                if ([good isEqualToString:[self nameForGood:key]])
                {
                    [self setQuantity:q forGood:key];
                    loadedOK = YES;
                    break;
                }
            }
        }
        else
        {
            loadedOK = YES;
        }
        if (!loadedOK)
        {
            OOLog(@"setCommanderDataFromDictionary.warning.cargo",@"Cargo %@ (%u units) could not be loaded from the saved game, as it is no longer defined",good,q);
        }
    }
}

References goods, nil, OOLog, and setQuantity:forGood:.

Referenced by PlayerEntity::setCommanderDataFromDictionary:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadStationAmounts:

- (void) loadStationAmounts: (NSArray *) amounts

Definition at line 360 of file OOCommodityMarket.m.

                           :(NSArray *)amounts
{
    OOCargoQuantity  q;
    OOCreditsQuantity  p;
    BOOL                loadedOK;
    NSString            *good = nil;
 
    NSArray *loaded = nil;
    foreach (loaded, amounts)
    {
        loadedOK = NO;
        good = [loaded oo_stringAtIndex:0];
        q = [loaded oo_unsignedIntAtIndex:1];
        p = [loaded oo_unsignedIntegerAtIndex:2];
        // old save games might have more in the array, but we don't care
        if (![self setQuantity:q forGood:good])
        {
            // then it's an array from a 1.80-or-earlier save game and
            // the good name is the description string (maybe a
            // translated one)
            OOCommodityType key = nil;
            foreach (key, [self goods])
            {
                if ([good isEqualToString:[self nameForGood:key]])
                {
                    [self setQuantity:q forGood:key];
                    [self setPrice:p forGood:key];
                    loadedOK = YES;
                    break;
                }
            }
        }
        else
        {
            [self setPrice:p forGood:good];
            loadedOK = YES;
        }
        if (!loadedOK)
        {
            OOLog(@"load.warning.cargo",@"Station market good %@ (%u units) could not be loaded from the saved game, as it is no longer defined",good,q);
        }
    }
}

References goods, nil, OOLog, setPrice:forGood:, and setQuantity:forGood:.

Referenced by StationEntity::setLocalMarket:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ massUnitForGood:

- (OOMassUnit) massUnitForGood: (OOCommodityType) good

Definition at line 225 of file OOCommodityMarket.m.

                              :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return UNITS_TONS;
    }
    return [definition oo_unsignedIntForKey:kOOCommodityContainer];
}

References nil, and UNITS_TONS.

Referenced by PlayerEntity::cargoQuantityOnBoard, Universe::describeCommodity:amount:, PlayerEntity::loadCargoPodsForType:amount:, PlayerEntity::loadCargoPodsForType:fromManifest:, marketSorterByMassUnit(), PlayerEntity::setCargoQuantityForType:amount:, PlayerEntity::setCommanderDataFromDictionary:, PlayerEntity::setGuiToMarketInfoScreen, and PlayerEntity::tryBuyingCommodity:all:.

Here is the caller graph for this function:

◆ nameForGood:

- (NSString *) nameForGood: (OOCommodityType) good

Definition at line 170 of file OOCommodityMarket.m.

                          :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return OOExpand(@"[oolite-unknown-commodity-name]");
    }
    return OOExpand([definition oo_stringForKey:kOOCommodityName defaultValue:@"[oolite-unknown-commodity-name]"]);
}

References kOOCommodityName, nil, and OOExpand.

Referenced by PlayerEntity::cargoListForScripting, Universe::describeCommodity:amount:, Universe::displayNameForCommodity:, marketSorterByName(), and PlayerEntity::setGuiToMarketInfoScreen.

Here is the caller graph for this function:

◆ priceForGood:

- (OOCreditsQuantity) priceForGood: (OOCommodityType) good

Definition at line 203 of file OOCommodityMarket.m.

                                  :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return 0;
    }
    return [definition oo_unsignedIntegerForKey:kOOCommodityPriceCurrent];
}

References nil.

Referenced by OOCommodities::generateMarketForStation:, marketSorterByPrice(), saveStationAmounts, PlayerEntity(OOPrivate)::showMarketScreenDataLine:forGood:inMarket:holdQuantity:, PlayerEntity::tryBuyingCommodity:all:, and PlayerEntity::trySellingCommodity:all:.

Here is the caller graph for this function:

◆ quantityForGood:

- (OOCargoQuantity) quantityForGood: (OOCommodityType) good

Definition at line 214 of file OOCommodityMarket.m.

                                   :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return 0;
    }
    return [definition oo_unsignedIntForKey:kOOCommodityQuantityCurrent];
}

References nil.

Referenced by addQuantity:forGood:, PlayerEntity::cargoListForScripting, PlayerEntity::cargoQuantityForType:, PlayerEntity::cargoQuantityOnBoard, OOCommodities::generateMarketForStation:, Universe::getContainersOfGoods:scarce:legal:, PlayerEntity::legalStatusOfCargoList, StationEntity::legalStatusOfManifest:export:, PlayerEntity::loadCargoPodsForType:amount:, PlayerEntity::loadCargoPodsForType:fromManifest:, marketSorterByQuantity(), removeQuantity:forGood:, savePlayerAmounts, saveStationAmounts, PlayerEntity::setCargoQuantityForType:amount:, PlayerEntity::setCommanderDataFromDictionary:, PlayerEntity::setGuiToMarketInfoScreen, PlayerEntity::setGuiToMarketScreen, PlayerEntity(OOPrivate)::showMarketScreenDataLine:forGood:inMarket:holdQuantity:, PlayerEntity::tryBuyingCommodity:all:, and PlayerEntity::trySellingCommodity:all:.

Here is the caller graph for this function:

◆ removeAllGoods

- (void) removeAllGoods

Definition at line 136 of file OOCommodityMarket.m.

{
    OOCommodityType good = nil;
    foreach (good, [_commodityList allKeys])
    {
        [self setQuantity:0 forGood:good];
    }
}

References _commodityList, nil, removeAllGoods, and setQuantity:forGood:.

Referenced by removeAllGoods.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeQuantity:forGood:

- (BOOL) removeQuantity:		(OOCargoQuantity)	quantity
forGood:		(OOCommodityType)	good

Definition at line 124 of file OOCommodityMarket.m.

                       :(OOCargoQuantity)quantity forGood:(OOCommodityType)good
{
    OOCargoQuantity current = [self quantityForGood:good];
    if (current < quantity)
    {
        return NO;
    }
    [self setQuantity:(current-quantity) forGood:good];
    return YES;
}

References quantityForGood:, and setQuantity:forGood:.

Referenced by PlayerEntity::setCommanderDataFromDictionary:, PlayerEntity::tryBuyingCommodity:all:, PlayerEntity::trySellingCommodity:all:, and PlayerEntity::unloadCargoPodsForType:amount:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ savePlayerAmounts

- (NSArray *) savePlayerAmounts

Definition at line 289 of file OOCommodityMarket.m.

{
    NSMutableArray *amounts = [NSMutableArray arrayWithCapacity:[self count]];
    OOCommodityType good = nil;
    foreach (good, [self goods])
    {
        [amounts addObject:[NSArray arrayWithObjects:good,[NSNumber numberWithUnsignedInt:[self quantityForGood:good]],nil]];
    }
    return [NSArray arrayWithArray:amounts];
}

References count, goods, nil, quantityForGood:, and savePlayerAmounts.

Referenced by PlayerEntity::commanderDataDictionary, and savePlayerAmounts.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveStationAmounts

- (NSArray *) saveStationAmounts

Definition at line 348 of file OOCommodityMarket.m.

{
    NSMutableArray *amounts = [NSMutableArray arrayWithCapacity:[self count]];
    OOCommodityType good = nil;
    foreach (good, [self goods])
    {
        [amounts addObject:[NSArray arrayWithObjects:good,[NSNumber numberWithUnsignedInt:[self quantityForGood:good]],[NSNumber numberWithUnsignedInteger:[self priceForGood:good]],nil]];
    }
    return [NSArray arrayWithArray:amounts];
}

References count, goods, nil, priceForGood:, quantityForGood:, and saveStationAmounts.

Referenced by Universe::getStationMarkets, and saveStationAmounts.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setComment:forGood:

- (BOOL) setComment:		(NSString *)	comment
forGood:		(OOCommodityType)	good

Definition at line 146 of file OOCommodityMarket.m.

                   :(NSString *)comment forGood:(OOCommodityType)good
{
    NSMutableDictionary *definition = [_commodityList oo_mutableDictionaryForKey:good];
    if (definition == nil)
    {
        return NO;
    }
    [definition setObject:comment forKey:kOOCommodityComment];
    return YES;
}

References nil.

◆ setGood:withInfo:

- (void) setGood:		(OOCommodityType)	key
withInfo:		(NSDictionary *)	info

Definition at line 63 of file OOCommodityMarket.m.

                :(OOCommodityType)key withInfo:(NSDictionary *)info
{
    NSMutableDictionary *definition = [NSMutableDictionary dictionaryWithDictionary:info];
    [_commodityList setObject:definition forKey:key];
    DESTROY(_sortedKeys); // reset
}

References _sortedKeys, and DESTROY.

Referenced by OOCommodities::generateBlankMarket, OOCommodities::generateManifestForPlayer, OOCommodities::generateMarketForStation:, and OOCommodities::generateMarketForSystemWithEconomy:andScript:.

Here is the caller graph for this function:

◆ setPrice:forGood:

- (BOOL) setPrice:		(OOCreditsQuantity)	price
forGood:		(OOCommodityType)	good

Definition at line 88 of file OOCommodityMarket.m.

                 :(OOCreditsQuantity)price forGood:(OOCommodityType)good
{
    NSMutableDictionary *definition = [_commodityList oo_mutableDictionaryForKey:good];
    if (definition == nil)
    {
        return NO;
    }
    [definition oo_setUnsignedInteger:price forKey:kOOCommodityPriceCurrent];
    return YES;
}

References nil.

Referenced by loadStationAmounts:, and StationEntity::setPrice:forCommodity:.

Here is the caller graph for this function:

◆ setQuantity:forGood:

- (BOOL) setQuantity:		(OOCargoQuantity)	quantity
forGood:		(OOCommodityType)	good

Definition at line 100 of file OOCommodityMarket.m.

                    :(OOCargoQuantity)quantity forGood:(OOCommodityType)good
{
    NSMutableDictionary *definition = [_commodityList oo_mutableDictionaryForKey:good];
    if (definition == nil || quantity > [self capacityForGood:good])
    {
        return NO;
    }
    [definition oo_setUnsignedInteger:quantity forKey:kOOCommodityQuantityCurrent];
    return YES;
}

References nil.

Referenced by addQuantity:forGood:, PlayerEntity::loadCargoPodsForType:amount:, PlayerEntity::loadCargoPodsForType:fromManifest:, loadPlayerAmounts:, loadStationAmounts:, removeAllGoods, removeQuantity:forGood:, PlayerEntity::setCargoQuantityForType:amount:, and StationEntity::setQuantity:forCommodity:.

Here is the caller graph for this function:

◆ setShortComment:forGood:

- (BOOL) setShortComment:		(NSString *)	comment
forGood:		(OOCommodityType)	good

Definition at line 158 of file OOCommodityMarket.m.

                        :(NSString *)comment forGood:(OOCommodityType)good
{
    NSMutableDictionary *definition = [_commodityList oo_mutableDictionaryForKey:good];
    if (definition == nil)
    {
        return NO;
    }
    [definition setObject:comment forKey:kOOCommodityShortComment];
    return YES;
}

References nil.

◆ shortCommentForGood:

- (NSString *) shortCommentForGood: (OOCommodityType) good

Definition at line 192 of file OOCommodityMarket.m.

                                  :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return OOExpand(@"[oolite-unknown-commodity-name]");
    }
    return OOExpand([definition oo_stringForKey:kOOCommodityShortComment defaultValue:@"[oolite-commodity-no-short-comment]"]);
}

References kOOCommodityShortComment, nil, and OOExpand.

◆ trumbleOpinionForGood:

- (float) trumbleOpinionForGood: (OOCommodityType) good

Definition at line 271 of file OOCommodityMarket.m.

                               :(OOCommodityType)good
{
    NSDictionary *definition = [_commodityList oo_dictionaryForKey:good];
    if (definition == nil)
    {
        return 0;
    }
    return [definition oo_floatForKey:kOOCommodityTrumbleOpinion];
}

References nil.

Member Data Documentation

◆ _commodityList

- (NSMutableDictionary*) _commodityList

private

Definition at line 34 of file OOCommodityMarket.h.

Referenced by dealloc, init, and removeAllGoods.

◆ _sortedKeys

- (NSArray*) _sortedKeys

private

Definition at line 35 of file OOCommodityMarket.h.

Referenced by dealloc, goods, init, and setGood:withInfo:.

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

src/Core/OOCommodityMarket.h
src/Core/OOCommodityMarket.m

Instance Methods

Private Attributes

Detailed Description

Method Documentation

◆ addQuantity:forGood:

◆ capacityForGood:

◆ commentForGood:

◆ count

◆ dealloc

◆ definitionForGood:

◆ dictionaryForScripting

◆ exportLegalityForGood:

◆ goods

◆ importLegalityForGood:

◆ init

◆ loadPlayerAmounts:

◆ loadStationAmounts:

◆ massUnitForGood:

◆ nameForGood:

◆ priceForGood:

◆ quantityForGood:

◆ removeAllGoods

◆ removeQuantity:forGood:

◆ savePlayerAmounts

◆ saveStationAmounts

◆ setComment:forGood:

◆ setGood:withInfo:

◆ setPrice:forGood:

◆ setQuantity:forGood:

◆ setShortComment:forGood:

◆ shortCommentForGood:

◆ trumbleOpinionForGood:

Member Data Documentation

◆ _commodityList

◆ _sortedKeys