OORoleSet Class Reference

#include <OORoleSet.h>

Inheritance diagram for OORoleSet:

Collaboration diagram for OORoleSet:

Instance Methods
(id)	- initWithRoleString:
(id)	- initWithRole:probability:
(NSString *)	- roleString
(BOOL)	- hasRole:
(float)	- probabilityForRole:
(BOOL)	- intersectsSet:
(NSSet *)	- roles
(NSArray *)	- sortedRoles
(NSDictionary *)	- rolesAndProbabilities
(NSString *)	- anyRole
(id)	- roleSetWithAddedRole:probability:
(id)	- roleSetWithAddedRoleIfNotSet:probability:
(id)	- roleSetWithRemovedRole:
(void)	- dealloc [implementation]
(NSString *)	- description [implementation]
(BOOL)	- isEqual: [implementation]
(NSUInteger)	- hash [implementation]
(id)	- copyWithZone: [implementation]
(id)	- initWithRolesAndProbabilities: [implementation]

Class Methods
(instancetype)	+ roleSetWithString:
(instancetype)	+ roleSetWithRole:probability:

Private Attributes
NSString *	_roleString
NSDictionary *	_rolesAndProbabilities
NSSet *	_roles
float	_totalProb

Detailed Description

Definition at line 35 of file OORoleSet.h.

Method Documentation

anyRole

- (NSString *) anyRole

Definition at line 312 of file OORoleSet.m.

{
    NSString                *role = nil;
    float                   prob, selected;
    
    selected = randf() * _totalProb;
    prob = 0.0f;
    
    if ([_rolesAndProbabilities count] == 0)  return nil;
    
    foreachkey (role, _rolesAndProbabilities)
    {
        prob += [_rolesAndProbabilities oo_floatForKey:role];
        if (selected <= prob)  break;
    }
    if (role == nil)
    {
        role = [[self roles] anyObject];
        OOLog(@"roleSet.anyRole.failed", @"Could not get a weighted-random role from role set %@, returning unweighted selection %@. TotalProb: %g, selected: %g, prob at end: %f", self, role, _totalProb, selected, prob);
    }
    return role;
}

References count, nil, and ScanTokensFromString().

Here is the call graph for this function:

copyWithZone:

- (id) copyWithZone: (NSZone *)  zone

implementation

Definition at line 312 of file OORoleSet.m.

                  :(NSZone *)zone
{
    // Note: since object is immutable, a copy is no different from the original.
    return [self retain];
}

dealloc

- (void) dealloc

implementation

Definition at line 312 of file OORoleSet.m.

{
    [_roleString autorelease];
    [_rolesAndProbabilities autorelease];
    [_roles autorelease];
    
    [super dealloc];
}

description

- (NSString *) description

implementation

Definition at line 312 of file OORoleSet.m.

{
    return [NSString stringWithFormat:@"<%@ %p>{%@}", [self class], self, [self roleString]];
}

hash

- (NSUInteger) hash

implementation

Definition at line 312 of file OORoleSet.m.

{
    return [_rolesAndProbabilities hash];
}

hasRole:

- (BOOL) hasRole:

(NSString *)

role

Definition at line 312 of file OORoleSet.m.

               :(NSString *)role
{
    return role != nil && [_rolesAndProbabilities objectForKey:role] != nil;
}

initWithRole:probability:

- (id) initWithRole:		(NSString *)	role
probability:		(float)	probability

Definition at line 312 of file OORoleSet.m.

                  :(NSString *)role probability:(float)probability
{
    NSDictionary            *dict = nil;
    
    if (role != nil && 0 <= probability)
    {
        dict = [NSDictionary dictionaryWithObject:[NSNumber numberWithFloat:probability] forKey:role];
    }
    return [self initWithRolesAndProbabilities:dict];
}

initWithRolesAndProbabilities:

- (id) initWithRolesAndProbabilities: (NSDictionary *)  dict

implementation

Provided by category OORoleSet(OOPrivate).

Definition at line 312 of file OORoleSet.m.

                                   :(NSDictionary *)dict
{
    NSString                *role = nil;
    float                   prob;
    
    if (dict == nil)
    {
        [self release];
        return nil;
    }
    
    self = [super init];
    if (self == nil)  return nil;
    
    // Note: _roles and _roleString are derived on the fly as needed.
    // MKW 20090815 - if we are re-initialising this OORoleSet object, we need
    //                to ensure that _roles and _roleString are cleared.
    // Why would we be re-initing? That's never valid. -- Ahruman 2010-02-06
    assert(_roles == nil && _roleString == nil);
    
    NSMutableDictionary     *tDict = [[dict mutableCopy] autorelease];
    float                   thargProb = [dict oo_floatForKey:@"thargon" defaultValue:0.0f];
    
    if ( thargProb > 0.0f && [dict objectForKey:@"EQ_THARGON"] == nil)
    {
        [tDict setObject:[NSNumber numberWithFloat:thargProb] forKey:@"EQ_THARGON"];
        [tDict removeObjectForKey:@"thargon"];
    }
    
    _rolesAndProbabilities = [tDict copy];
    
    foreachkey (role, dict)
    {
        prob = [dict oo_floatForKey:role defaultValue:-1];
        if (prob < 0)
        {
            OOLog(@"roleSet.badValue", @"Attempt to create a role set with negative or non-numerical probability for role %@.", role);
            [self release];
            return nil;
        }
        
        _totalProb += prob;
    }
    
    return self;
}

initWithRoleString:

- (id) initWithRoleString:

(NSString *)

roleString

Definition at line 312 of file OORoleSet.m.

                        :(NSString *)roleString
{
    NSDictionary            *dict = nil;
    
    dict = OOParseRolesFromString(roleString);
    return [self initWithRolesAndProbabilities:dict];
}

intersectsSet:

- (BOOL) intersectsSet:

(id)

set

Definition at line 312 of file OORoleSet.m.

                     :(id)set
{
    if ([set isKindOfClass:[OORoleSet class]])  set = [set roles];
    else  if (![set isKindOfClass:[NSSet class]])  return NO;
    
    return [[self roles] intersectsSet:set];
}

isEqual:

- (BOOL) isEqual: (id)  other

implementation

Definition at line 312 of file OORoleSet.m.

               :(id)other
{
    if ([other isKindOfClass:[OORoleSet class]])
    {
        return [_rolesAndProbabilities isEqual:[other rolesAndProbabilities]];
    }
    else  return NO;
}

probabilityForRole:

- (float) probabilityForRole:

(NSString *)

role

Definition at line 312 of file OORoleSet.m.

                           :(NSString *)role
{
    return [_rolesAndProbabilities oo_floatForKey:role defaultValue:0.0f];
}

roles

- (NSSet *) roles

Definition at line 312 of file OORoleSet.m.

{
    if (_roles == nil)
    {
        _roles = [[NSSet alloc] initWithArray:[_rolesAndProbabilities allKeys]];
    }
    return _roles;
}

rolesAndProbabilities

- (NSDictionary *) rolesAndProbabilities

Definition at line 312 of file OORoleSet.m.

{
    return _rolesAndProbabilities;
}

Referenced by ShipGetProperty().

Here is the caller graph for this function:

roleSetWithAddedRole:probability:

- (id) roleSetWithAddedRole:		(NSString *)	role
probability:		(float)	probability

Definition at line 312 of file OORoleSet.m.

                          :(NSString *)role probability:(float)probability
{
    NSMutableDictionary     *dict = nil;
    
    if (role == nil || probability < 0 || [self hasRole:role])
    {
        return [[self copy] autorelease];
    }
    
    dict = [[_rolesAndProbabilities mutableCopy] autorelease];
    [dict setObject:[NSNumber numberWithFloat:probability] forKey:role];
    return [[[[self class] alloc] initWithRolesAndProbabilities:dict] autorelease];
}

roleSetWithAddedRoleIfNotSet:probability:

- (id) roleSetWithAddedRoleIfNotSet:		(NSString *)	role
probability:		(float)	probability

Definition at line 312 of file OORoleSet.m.

                                  :(NSString *)role probability:(float)probability
{
    NSMutableDictionary     *dict = nil;
    
    if (role == nil || probability < 0 || ([self hasRole:role] && [self probabilityForRole:role] == probability))
    {
        return [[self copy] autorelease];
    }
    
    dict = [[_rolesAndProbabilities mutableCopy] autorelease];
    [dict setObject:[NSNumber numberWithFloat:probability] forKey:role];
    return [[[[self class] alloc] initWithRolesAndProbabilities:dict] autorelease];
}

roleSetWithRemovedRole:

- (id) roleSetWithRemovedRole:

(NSString *)

role

Definition at line 312 of file OORoleSet.m.

                            :(NSString *)role
{
    NSMutableDictionary     *dict = nil;
    
    if (![self hasRole:role])  return [[self copy] autorelease];
    
    dict = [[_rolesAndProbabilities mutableCopy] autorelease];
    [dict removeObjectForKey:role];
    return [[[[self class] alloc] initWithRolesAndProbabilities:dict] autorelease];
}

roleSetWithRole:probability:

+ (instancetype) roleSetWithRole:		(NSString *)	role
probability:		(float)	probability

Definition at line 312 of file OORoleSet.m.

                                :(NSString *)role probability:(float)probability
{
    return [[[self alloc] initWithRole:role probability:probability] autorelease];
}

roleSetWithString:

+ (instancetype) roleSetWithString:

(NSString *)

roleString

Definition at line 312 of file OORoleSet.m.

                                  :(NSString *)roleString
{
    return [[[self alloc] initWithRoleString:roleString] autorelease];
}

roleString

- (NSString *) roleString

Definition at line 312 of file OORoleSet.m.

{
    NSArray                 *roles = nil;
    NSString                *role = nil;
    float                   probability;
    NSMutableString         *result = nil;
    BOOL                    first = YES;
    
    if (_roleString == nil)
    {
        // Construct role string. We always do this so that it's in a normalized form.
        result = [NSMutableString string];
        roles = [self sortedRoles];
        foreach (role, roles)
        {
            if (!first)  [result appendString:@" "];
            else  first = NO;
            
            [result appendString:role];
            
            probability = [self probabilityForRole:role];
            if (probability != 1.0f)
            {
                [result appendFormat:@"(%g)", probability];
            }
        }
        
        _roleString = [result copy];
    }
    
    return _roleString;
}

sortedRoles

- (NSArray *) sortedRoles

Definition at line 312 of file OORoleSet.m.

{
    return [[_rolesAndProbabilities allKeys] sortedArrayUsingSelector:@selector(caseInsensitiveCompare:)];
}

Referenced by ShipGetProperty().

Here is the caller graph for this function:

Member Data Documentation

_roles

- (NSSet*) _roles

private

Definition at line 41 of file OORoleSet.h.

_rolesAndProbabilities

- (NSDictionary*) _rolesAndProbabilities

private

Definition at line 40 of file OORoleSet.h.

_roleString

- (NSString*) _roleString

private

Definition at line 39 of file OORoleSet.h.

_totalProb

- (float) _totalProb

private

Definition at line 42 of file OORoleSet.h.

---

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

• src/Core/OORoleSet.h
• src/Core/OORoleSet.m