Class: TPropertyIDSet

Declaration: Property.h

Taxonomy Categories:

Member Functions:

TPropertyIDSet
operator=
~TPropertyIDSet
Add
Delete
DeleteAll
Member
Members
Count
operator==
operator!=
operator>>=
operator<<=

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

Provides a collection of property identifiers that can be retrieved or deleted from an MPropertyStore in a single operation.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is not intended to be derived from.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPropertyIDSet::TPropertyIDSet

TPropertyIDSet ()
TPropertyIDSet (const TPropertyIDSet & copy)
TPropertyIDSet (const TPropertySet & copy)

Interface Category:

API.

Purpose:

Default constructor -Constructs an empty property identifier set.
Copy constructor.
Constructs a property identifier set from a property set.

Calling Context:

Called by the stream-in operators and to create an instance to assign to.
Called to copy an object.
Called to create a TPropertyIDSet from a TPropertySet.

Parameters:

Takes no parameters.
const TPropertyIDSet & copy -The property identifier set to copy from.
const TPropertySet & copy -The property set to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::operator=

TPropertyIDSet & operator =(const TPropertyIDSet & copy)
TPropertyIDSet & operator =(const TPropertySet & copy)

Interface Category:

API.

Purpose:

Assignment operator.
Assigns the identifiers contained in its argument to this object.

Calling Context:

Called when an object is assigned to another compatible object.
Call this function directly.

Parameters:

const TPropertyIDSet & copy -The property identifier set to copy from.
const TPropertySet & copy -The property set to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::~TPropertyIDSet

virtual ~ TPropertyIDSet ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::Add

virtual void Add (const TPropertyID & id)
virtual void Add (const TPropertyIDSet & set)
virtual void Add (const TProperty & property)
virtual void Add (const TPropertySet & set)

Interface Category:

API.

Purpose:

Adds a property identifier to this set.
Adds one or more property identifiers to this set.
Adds a property identifier to this set; extracts the identifier from a property object.
Adds one or more property identifiers to this set; extracts the identifiers from property objects.

Calling Context:

Call this function directly.
Call this function directly.
Call this function directly.
Call this function directly.

Parameters:

const TPropertyID & id -The property identifier to add to this set.
const TPropertyIDSet & set -The set of property identifiers to add to this set.
const TProperty & property -The object to extract a property identifier from.
const TPropertySet & set -The set of objects to extract the property identifiers from.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

If any identifier argument is either TPropertyID::kInvalid or TPropertyIDSetIterator::kEndOfIteration or if the identifier already exists in the set, no operation is performed for that identifier.

Member Function: TPropertyIDSet::Delete

virtual bool Delete (const TPropertyID & id)
virtual bool Delete (const TPropertyIDSet & set)

Interface Category:

API.

Purpose:

Deletes a property identifier from this set.
Deletes one or more property identifiers from this set.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TPropertyID & id -The property identifier to delete from this set.
const TPropertyIDSet & set -The set of property identifiers to delete from this set.

Return Value:

Returns true if the identifiers were members of this set.

Exceptions:

Throws TObjectPassedToSelf if the set equals this.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::DeleteAll

virtual void DeleteAll ()

Interface Category:

API.

Purpose:

Deletes all property identifiers from this set.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::Member

virtual bool Member (const TPropertyID & id) const

Interface Category:

API.

Purpose:

Determines if a specified property identifier is present in this set.

Calling Context:

Call this function directly.

Parameters:

const TPropertyID & id -The property identifier to look for.

Return Value:

Returns true if the specified property identifier is present in this set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::Members

virtual bool Members (const TPropertyIDSet & set) const

Interface Category:

API.

Purpose:

Determines if all the specified property identifiers are present in this set.

Calling Context:

Call this function directly.

Parameters:

const TPropertyIDSet & set -The set of property identifiers to look for.

Return Value:

Returns true if all the specified property identifiers are present in this set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::Count

virtual unsigned long Count () const

Interface Category:

API.

Purpose:

Returns the number of property identifiers present in this set.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

An unsigned long.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::operator==

bool operator ==(const TPropertyIDSet & set) const

Interface Category:

API.

Purpose:

Determines if this property identifier set equals its argument.

Calling Context:

Called to test the equivalence of two objects.

Parameters:

const TPropertyIDSet & set -The property identifier set to compare to this object.

Return Value:

Returns true if both sets are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::operator!=

bool operator != (const TPropertyIDSet & set) const

Interface Category:

API.

Purpose:

Determines if this property identifier set is different from its argument.

Calling Context:

Called to test the equivalence of two objects.

Parameters:

const TPropertyIDSet & set -The property identifier set to compare to this object.

Return Value:

Returns true if the sets are not equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TPropertyIDSet::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromwhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.