OORoleSet.h

Go to the documentation of this file.

/*
 
OORoleSet.h
 
Manage a set of roles for a ship (or ship type), including probabilities.
 
A role set is an immutable object. 
 
 
Copyright (C) 2007-2013 Jens Ayton
 
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
 
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
 
*/
 
#import "OOCocoa.h"
 
 
@interface OORoleSet: NSObject <NSCopying>
{
@private
    NSString                    *_roleString;
    NSDictionary                *_rolesAndProbabilities;
    NSSet                       *_roles;
    float                       _totalProb;
}
 
+ (instancetype) roleSetWithString:(NSString *)roleString;
+ (instancetype) roleSetWithRole:(NSString *)role probability:(float)probability;
 
- (id)initWithRoleString:(NSString *)roleString;
- (id)initWithRole:(NSString *)role probability:(float)probability;
 
- (NSString *)roleString;
 
- (BOOL)hasRole:(NSString *)role;
- (float)probabilityForRole:(NSString *)role;
- (BOOL)intersectsSet:(id)set;  // set may be an OORoleSet or an NSSet.
 
- (NSSet *)roles;
- (NSArray *)sortedRoles;
- (NSDictionary *)rolesAndProbabilities;
 
// Returns a random role, taking probabilities into account.
- (NSString *)anyRole;
 
    // Creating modified copies of role sets:
- (id)roleSetWithAddedRole:(NSString *)role probability:(float)probability;
- (id)roleSetWithAddedRoleIfNotSet:(NSString *)role probability:(float)probability; // Unlike the above, does not change probability if role exists.
- (id)roleSetWithRemovedRole:(NSString *)role;
 
@end
 
 
// Returns a dictionary whose keys are roles and whose values are weights.
NSDictionary *OOParseRolesFromString(NSString *string);