SCSet Class Reference

Objects unordered set class. More...

#import <SCSet.h>

Inheritance diagram for SCSet:

List of all members.

Public Member Functions
Initializing Set
(id)	- init
(id)	- initWithSetName:capacity:
(id)	- initWithSetName:
(id)	- initWithCapacity:
(id)	- initWithDelegate:
(id)	- initWithDelegate:collection:
(id)	- initWithCollection:
(id)	- initWithDelegate:object:
(id)	- initWithObject:
(id)	- initWithDelegate:objects:
(id)	- initWithObjects:
(id)	- initWithSet:
Querying and Setting Set Properties
(NSString *)	- setName
(void)	- setSetName:
Querying Set
(SCArray *)	- allObjects
(id)	- anyObject
Comparing Sets
(BOOL)	- isSubsetOfCollection:
(BOOL)	- intersectsCollection:
Removing Objects
(void)	- removeObject:
(void)	- removeByte:
(void)	- removeUByte:
(void)	- removeShort:
(void)	- removeUShort:
(void)	- removeInteger:
(void)	- removeUInteger:
(void)	- removeLong:
(void)	- removeULong:
(void)	- removeChar:
(void)	- removeUnichar:
(void)	- removeCharString:
(void)	- removeBool:
(void)	- removeFloat:
(void)	- removeDouble:
(void)	- removeObjects:
(void)	- removeObjectsInCollection:
(void)	- removeObjectsEqualTo:
Combining and Recombining Sets
(void)	- unionCollection:
(void)	- minusCollection:
(void)	- intersectCollection:
Static Public Member Functions
Creating Set
(SCSet *)	+ setWithDataDictionary:
(SCSet *)	+ setWithDataDictionaryFromFile:
(SCSet *)	+ setWithCoder:
(SCSet *)	+ setWithContentsOfSerializedFile:
(SCSet *)	+ setWithStream:
(SCSet *)	+ setWithFileStream:
(SCSet *)	+ set
(SCSet *)	+ setWithSetName:capacity:
(SCSet *)	+ setWithSetName:
(SCSet *)	+ setWithCapacity:
(SCSet *)	+ setWithDelegate:
(SCSet *)	+ setWithDelegate:collection:
(SCSet *)	+ setWithCollection:
(SCSet *)	+ setWithDelegate:object:
(SCSet *)	+ setWithObject:
(SCSet *)	+ setWithDelegate:objects:
(SCSet *)	+ setWithObjects:
(SCSet *)	+ setWithSet:

---

Detailed Description

Objects unordered set class.

Class implements the representation of an class instances unordered collection called set and declares items management methods.
Class was introduced in version 1.1.3.

Class declares the following properties:

• NSString* setName - set name

---

Member Function Documentation

- (SCArray *) allObjects

Returns an array containing the set's members.

Returns:

Array with set's members or an empty array if the set has no members.

- (id) anyObject

Returns one of the objects in the set.

Returns:

One object from the set or nil if the set contains no objects

- (id) init

Initializes the set using the default settings.

Returns:

A newly initialized set

Reimplemented from SCCollection.

- (id) initWithCapacity:

(SCULong)

capacity

Initializes the set using the specified capacity.

Parameters:

capacity

- set capacity

Returns:

A newly initialized set

- (id) initWithCollection:

(id)

collection

Initializes the set using the specified existing collection.

Parameters:

collection

- existing source collection

Returns:

A newly initialized set

Exceptions:

SCCollectionException

- set error detected

- (id) initWithDelegate:

(id<SCCollectionDelegate>)

delegate

Initializes the set using the specified delegate object.

Parameters:

delegate

- set delegate object

Returns:

A newly initialized set

- (id) initWithDelegate:		(id<SCCollectionDelegate>)	delegate
collection:		(id)	collection

Initializes the set using the specified delegate object and existing collection.

Parameters:

delegate	- delegate object
collection	- existing source collection

Returns:

A newly initialized set

Exceptions:

SCCollectionException

- set error detected

- (id) initWithDelegate:		(id<SCCollectionDelegate>)	delegate
object:		(id)	object

Initializes the set using the specified delegate object and existing object.

Parameters:

delegate	- delegate object
object	- existing object

Returns:

A newly initialized set

Exceptions:

SCCollectionException

- set error detected

- (id) initWithDelegate:		(id<SCCollectionDelegate>)	delegate
objects:		(id)	object
,			...

Initializes the set using the specified delegate objects and nil terminated list of existing objects.

Parameters:

delegate	- delegate object
object	- first object
...	- other objects

Returns:

A newly initialized set

Exceptions:

SCCollectionException

- set error detected

- (id) initWithObject:

(id)

object

Initializes the set using the specified existing object.

Parameters:

object

- existing object

Returns:

A newly initialized set

Exceptions:

SCCollectionException

- set error detected

- (id) initWithObjects:		(id)	object
,			...

Initializes the set using the specified nil terminated list of existing objects.

Parameters:

object	- first object
...	- other objects

Returns:

A newly initialized set

Exceptions:

SCCollectionException

- set error detected

- (id) initWithSet:

(SCSet *)

set

Initializes the set using the existing set.

Parameters:

set	- source set

Returns:

A newly initialized set

Exceptions:

SCCollectionError

- set error detected

- (id) initWithSetName:

(NSString *)

name

Initializes the set using the specified set name.

Parameters:

name	- set name

Returns:

A newly initialized set

- (id) initWithSetName:		(NSString *)	name
capacity:		(SCULong)	capacity

Initializes the set using the sepcified set name and capacity.

Parameters:

name	- set name
capacity	- set capacity

Returns:

A newly initialized set

- (void) intersectCollection:

(id)

collection

Removes from the receiving set each object that isn't a member of the specified collection.

Parameters:

collection

- collection with which to perform the intersection

Exceptions:

SCCollectionException

- set error detected

- (BOOL) intersectsCollection:

(id)

collection

Returns a boolean value that indicates whether at least one object in the receiving set is also present in a given set.

Parameters:

collection

- collection with which to compare the receiving set

Returns:

YES if at least one object in the receiving set is present in collection, otherwise NO

Exceptions:

SCCollectionException

- set error detected

- (BOOL) isSubsetOfCollection:

(id)

collection

Returns a boolean value that indicates whether every object in the receiving set is also present in a given collection.

Parameters:

collection

- collection with which to compare the receiving set

Returns:

YES if every object in the receiving set is also present in the collection, otherwise NO

Exceptions:

SCCollectionException

- set error detected

- (void) minusCollection:

(id)

collection

Removes each object in another given collection from the receiving set, if present.

Parameters:

collection

- collection of objects to remove from the receiving set

Exceptions:

SCCollectionException

- set error detected

- (void) removeBool:

(BOOL)

boolean

Removes from the set the specified boolean value.

Parameters:

boolean

- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeByte:

(SCByte)

byte

Removes from the set the specified signed 8-bit integer value.

Parameters:

byte	- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeChar:

(char)

chr

Removes from the set the specified char value.

Parameters:

chr	- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeCharString:

(const char *)

string

Removes from the set the specified char string.

Parameters:

string

- string to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeDouble:

(SCDouble)

dbl

Removes from the set the specified double precision float value.

Parameters:

dbl	- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeFloat:

(SCFloat)

flt

Removes from the set the specified single precision float value.

Parameters:

flt	- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeInteger:

(SCInteger)

integer

Removes from the set the specified signed 32-bit integer value.

Parameters:

integer

- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeLong:

(SCLong)

longint

Removes from the set the specified signed 64-bit integer value.

Parameters:

longint

- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeObject:

(id)

object

Removes a given object from the set.

Parameters:

object

- object to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeObjects:		(id)	object
,			...

Removes from the set objects from the specified nil terminated list.

Parameters:

object	- first object to remove from the set
...	- other objects to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeObjectsEqualTo:

(id)

object

Removes from the receiving set all objects which equal to the specified object.

Parameters:

object

- template object

Exceptions:

SCCollectionException

- set error detected

- (void) removeObjectsInCollection:

(id)

collection

Removes from the receiving set the objects in the specified collection.

Parameters:

collection

- collection containing the objects to be removed from the receiving set

Exceptions:

SCCollectionException

- set error detected

- (void) removeShort:

(SCShort)

shortint

Removes from the set the specified signed 16-bit integer value.

Parameters:

shortint

- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeUByte:

(SCUByte)

byte

Removes from the set the specified unsigned 8-bit integer value.

Parameters:

byte	- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeUInteger:

(SCUInteger)

integer

Removes from the set the specified unsigned 32-bit integer value.

Parameters:

integer

- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeULong:

(SCULong)

longint

Removes from the set the specified unsigned 64-bit integer value.

Parameters:

longint

- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeUnichar:

(unichar)

chr

Removes from the set the specified unichar value.

Parameters:

chr	- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

- (void) removeUShort:

(SCUShort)

shortint

Removes from the set the specified unsigned 16-bit integer value.

Parameters:

shortint

- value to remove from the set

Exceptions:

SCCollectionException

- set error detected

+ (SCSet *) set

Return the set created by using the default settings.

Returns:

A created set

Reimplemented from SCCollection.

- (NSString *) setName

Returns the receiving set name.

Returns:

Set name

- (void) setSetName:

(NSString *)

name

Sets the name of the receiving set.

Parameters:

name	- set name

+ (SCSet *) setWithCapacity:

(SCULong)

capacity

Returns the set created by using the specified capacity.

Parameters:

capacity

- set capacity

Returns:

A created set

+ (SCSet *) setWithCoder:

(NSCoder *)

coder

Returns a set created by using the specified coder.

Parameters:

coder

- source coder

Returns:

A created set

+ (SCSet *) setWithCollection:

(id)

collection

Returns the set created by using the specified existing collection.

Parameters:

collection

- existing source collection

Returns:

A created set

Exceptions:

SCCollectionException

- set error detected

+ (SCSet *) setWithContentsOfSerializedFile:

(NSString *)

path

Returns a set created by using the contents of serialized file with the specified path.

Parameters:

path	- source serialized file path

Returns:

A created set

+ (SCSet *) setWithDataDictionary:

(NSDictionary *)

dictionary

Returns a set created by using the specified dictionary.

Parameters:

dictionary

- source dictionary

Returns:

A created set

+ (SCSet *) setWithDataDictionaryFromFile:

(NSString *)

path

Returns a set created by using the dictionary from the specified file.

Parameters:

path	- source dictionary file path

Returns:

A created set

+ (SCSet *) setWithDelegate:

(id<SCCollectionDelegate>)

delegate

Returns the set created by using the specified delegate object.

Parameters:

delegate

- set delegate object

Returns:

A created set

+ (SCSet *) setWithDelegate:		(id<SCCollectionDelegate>)	delegate
collection:		(id)	collection

Returns the set created by using the specified delegate object and existing collection.

Parameters:

delegate	- delegate object
collection	- existing source collection

Returns:

A created set

Exceptions:

SCCollectionException

- set error detected

+ (SCSet *) setWithDelegate:		(id<SCCollectionDelegate>)	delegate
object:		(id)	object

Returns the set created by using the specified delegate object and existing object.

Parameters:

delegate	- delegate object
object	- existing object

Returns:

A created set

Exceptions:

SCCollectionException

- set error detected

+ (SCSet *) setWithDelegate:		(id<SCCollectionDelegate>)	delegate
objects:		(id)	object
,			...

Returns the set created by using the specified delegate objects and nil terminated list of existing objects.

Parameters:

delegate	- delegate object
object	- first object
...	- other objects

Returns:

A created set

Exceptions:

SCCollectionException

- set error detected

+ (SCSet *) setWithFileStream:

(NSString *)

path

Returns a set created from the stream file with the specified path.

Parameters:

path	- stream file path

Returns:

A created set

Exceptions:

SCStreamException

- stream operation error detected

+ (SCSet *) setWithObject:

(id)

object

Returns the set created by using the specified existing object.

Parameters:

object

- existing object

Returns:

A created set

Exceptions:

SCCollectionException

- set error detected

+ (SCSet *) setWithObjects:		(id)	object
,			...

Returns the set created by using the specified nil terminated list of existing objects.

Parameters:

object	- first object
...	- other objects

Returns:

A created set

Exceptions:

SCCollectionException

- set error detected

+ (SCSet *) setWithSet:

(SCSet *)

set

Returns the set created by using the existing set.

Parameters:

set	- source set

Returns:

A created set

Exceptions:

SCCollectionError

- set error detected

+ (SCSet *) setWithSetName:

(NSString *)

name

Returns the set created by using the specified set name.

Parameters:

name	- set name

Returns:

A created set

+ (SCSet *) setWithSetName:		(NSString *)	name
capacity:		(SCULong)	capacity

Returns the set created by using the specified set name and capacity.

Parameters:

name	- set name
capacity	- set capacity

Returns:

A created set

+ (SCSet *) setWithStream:

(SCStream *)

stream

Returns a set created from the specified stream.

Parameters:

stream

- stream for reading set

Returns:

A created set

Exceptions:

SCStreamException	- stream operation error detected
SCSystemException	- system error detected

- (void) unionCollection:

(id)

collection

Adds each object from the specified collection to the receiving set, if not present.

Parameters:

collection

- collection of objects to add to the receiving set

Exceptions:

SCCollectionException

- set error detected

---

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

• SCSet.h
• SCSet.m