Class: TProperty

Declaration: Property.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TPropertyFor

Purpose:

Represents a property that can be read from or written to an MPropertyStore object.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TProperty is intended to be derived only by TPropertyFor<AType>.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TProperty::TProperty

TProperty ()
TProperty (const TPropertyID & id)
TProperty (const TProperty & copy)

Interface Category:

API.

Purpose:

Default constructor; matches kInvalid.
Constructs a property with an invalid value.
Copy constructor. Does not perform a runtime type check.

Calling Context:

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

Parameters:

Takes no parameters.
const TPropertyID & id -The identifier to for this property.
const TProperty & copy -The property to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TProperty::operator=

TProperty & operator =(const TProperty & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TProperty & right -The TProperty to assign to this object.

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:

Does not perform a runtime type check.

Member Function: TProperty::~TProperty

~ TProperty ()

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: TProperty::operatorTPropertyID

operator TPropertyID () const

Interface Category:

API.

Purpose:

Returns the property identifier.

Calling Context:

Called to pass a TProperty object to any function that takes a TPropertyID.

Parameters:

Takes no parameters.

Return Value:

The property identifier for this object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TProperty::GetID

TPropertyID GetID () const

Interface Category:

API.

Purpose:

Returns the property identifier.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The property identifier for this object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TProperty::HasValidValue

bool HasValidValue () const

Interface Category:

API.

Purpose:

Determines if this object has a valid value.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns true if this object has a valid value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TProperty::GetIDHash

HashResult GetIDHash () const

Interface Category:

API.

Purpose:

Produces a hash key for the contained TPropertyID.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The hash key.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TProperty::GetValueHash

HashResult GetValueHash () const

Interface Category:

API.

Purpose:

Produces a hash key for the contained value (equivalent to GetValue (aProperty)->Hash()).

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The hash key.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TProperty::operator==

bool operator ==(const TPropertyID & right) const

Interface Category:

API.

Purpose:

Determines if its argument is equal to the identifier component of this object.

Calling Context:

Called to test the equivalence of two objects.

Parameters:

const TPropertyID & right -The property identifier to compare with this object's identifier component.

Return Value:

Returns true if both identifiers are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TProperty::operator!=

bool operator != (const TPropertyID & right) const

Interface Category:

API.

Purpose:

Determines if its argument is different from the identifier component of this object.

Calling Context:

Called to test the equivalence of two objects.

Parameters:

const TPropertyID & right -The property identifier to compare with this object's identifier component.

Return Value:

Returns true if the identifiers are different.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TProperty::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Produces a hash key for this object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The hash key.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

Not multithread safe.

Other Considerations:

None.

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