Class: TPropertySet

Declaration: Property.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible, MQueryTarget

Inherited By:

None.

Purpose:

Provides a set of properties that can be stored in or retrieved from an MPropertyStore object. This class enables a collection of properties to be read or written 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: TPropertySet::TPropertySet

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

Interface Category:

API.

Purpose:

Default constructor. Constructs an empty property set.
Copy constructor. Constructs a property set from the contents of another property set.
Constructs a property set from the contents of an identifier set. The set will contain no valid values.

Calling Context:

Called by the stream-in operators and to create an instance to assign to.
Called to copy an object.
Call this function directly.

Parameters:

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

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::operator=

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

Interface Category:

API.

Purpose:

Assignment operator.
Replaces the contents of this property set with the contents of an identifier set. The set will contain no valid values.

Calling Context:

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

Parameters:

const TPropertySet & copy -The property set to assign to this object.
const TPropertyIDSet & copy -The identifier set to extract a property set from.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::~TPropertySet

virtual ~ TPropertySet ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::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:

Constructs a property, using the specified identifier and an invalid value, and adds it to this set.
Constructs a property set, using the specified identifier set and a set of invalid values, and adds it to this set.
Adds a property to this property set. If the property argument is TProperty::kInvalid or TPropertySetIterator::kEndOfIteration, or if the property already exists in the set, no operation is performed.
Adds a property set to this property set. If any property in the set is TProperty::kInvalid or TPropertySetIterator::kEndOfIteration, or if any property already exists in the set, no operation is performed for that property.

Calling Context:

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

Parameters:

const TPropertyID & id -The identifier to construct the property from.
const TPropertyIDSet & set -The identifier set to construct the property set from.
const TProperty & property -The property to add to this set.
const TPropertySet & set -The property set to add to this set.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::Get

virtual bool Get (TProperty & fillin) const

Interface Category:

API.

Purpose:

Retrieves the property designated by its argument.

Calling Context:

Call this function directly.

Parameters:

TProperty & fillin -The property to look for in the set. On return, fillin contains the property.

Return Value:

Returns true if fillin is present in the set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::Delete

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

Interface Category:

API.

Purpose:

Deletes the specified property from this set.
Deletes the specified property set from this set.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

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

Return Value:

Returns true if all the specified properties were present in the set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::DeleteAll

virtual void DeleteAll ()

Interface Category:

API.

Purpose:

Deletes all the properties 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:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::Member

virtual bool Member (const TPropertyID & id) const

Interface Category:

API.

Purpose:

Determines if the specified property is present in this set.

Calling Context:

Call this function directly.

Parameters:

const TPropertyID & id -The property to look for.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::Members

virtual bool Members (const TPropertyIDSet & set) const

Interface Category:

API.

Purpose:

Determines if all properties specified by the set are present in this set.

Calling Context:

Call this function directly.

Parameters:

const TPropertyIDSet & set -The set of properties to look for.

Return Value:

Returns true if all properties specified by the set are present in this set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::Count

virtual unsigned long Count () const

Interface Category:

API.

Purpose:

Returns the number of properties in this set.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The number of properties present in this set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::ValidValues

virtual unsigned long ValidValues () const
virtual unsigned long ValidValues (TPropertySet & fillin) const

Interface Category:

API.

Purpose:

Returns the count of properties with valid values in this set.
Retrieves all properties with valid values in this set.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
TPropertySet & fillin -On return, contains the set of properties with valid values; fillin is emptied prior to retrieval.

Return Value:

The count of properties with valid values in this set.

Exceptions:

Throws no exceptions, passes all exceptions through.
Throws TObjectPassedToSelf if the set equals this.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::InvalidValues

virtual unsigned long InvalidValues () const
virtual unsigned long InvalidValues (TPropertyIDSet & fillin) const

Interface Category:

API.

Purpose:

Returns the count of properties with invalid values in this set.
Retrieves the identifiers for all properties with invalid values in this set.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
TPropertyIDSet & fillin -On return, contains the identifier set for all properties with invalid values; fillin is emptied prior to retrieval.

Return Value:

The count of properties with invalid values in this set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::HasValidValue

virtual bool HasValidValue (const TPropertyID & id) const

Interface Category:

API.

Purpose:

Determines if the specified property is a member of this set and has a valid value.

Calling Context:

Call this function directly.

Parameters:

const TPropertyID & id -The property to search for.

Return Value:

Returns true if the specified property is a member of this set and has a valid value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::operator==

bool operator ==(const TPropertyIDSet & set) const

Interface Category:

API.

Purpose:

Determines if this set contains exactly the same identifiers as specified in its argument.

Calling Context:

Call this function directly.

Parameters:

const TPropertyIDSet & set -The set of IDs to test for in this object.

Return Value:

Returns true if this set contains exactly the same identifiers as specified in its argument.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::operator!=

bool operator != (const TPropertyIDSet & set) const

Interface Category:

API.

Purpose:

Determines if this set does not contain exactly the same identifiers as specified in its argument.

Calling Context:

Call this function directly.

Parameters:

const TPropertyIDSet & set -The set of IDs to test for in this object.

Return Value:

Returns true if this set does not contain exactly the same identifiers as specified in its argument.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::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:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertySet::operator<<=

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. Call this function directly.

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:

Not multithread safe.

Other Considerations:

None.

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