Class: TPropertyFor

Declaration: Property.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TProperty

Inherited By:

None.

Purpose:

TPropertyFor is a derived class of TProperty class which provides protocol for dealing with values of type AType. AType can be any of the portable primitive types or any class type which has the following public functions: AType (); AType (const AType& copy); HashResult Hash () const; bool operator ==(const AType& right) const; TStream& operator >>=(TStream& toWhere) const; TStream& operator <<= (TStream& fromWhere); The primitive types supported are: signed char signed short signed long unsigned char unsigned short unsigned long double float

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: TPropertyFor::TPropertyFor

TPropertyFor (const TPropertyIDFor < AType > & id)
TPropertyFor (const TPropertyName & name, TPropertyID :: EValueFilter filter =TPropertyID :: kMonomorphicValues)
TPropertyFor (const TPropertyIDFor < AType > & id, const AType & value)
TPropertyFor (const TPropertyName & name, const AType & value, TPropertyID :: EValueFilter filter =TPropertyID :: kMonomorphicValues)
TPropertyFor (const TPropertyFor < AType > & copy)
TPropertyFor (const TProperty & right)
TPropertyFor ()

Interface Category:

API

Purpose:

Constructs a property with the specified ID and an invalid value.
Constructs a property with the specified name and an invalid value. Constructs the ID from the name.
Constructs a property with the specified ID and value.
Constructs a property with the specified name and value. Constructs the ID from the name.
Constructs a property with the content of the argument.
Determines if the type of its argument is equivalent to the type of this object, and if so, constructs a property with the content of the argument.
Default constructor.

Calling Context:

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

Parameters:

const TPropertyIDFor < AType > & id -The identifier for this property.
const TPropertyName & name -The name to use to construct the identifier for this property.
TPropertyID::EvalueFilter filter =TPropertyID::kMonomorphicValues -See TPropertyID::EValueFilter.
const TPropertyIDFor < AType > & id -The identifier for this property.
const AType & value -The value for this property.
const TPropertyName & name -The name to use to construct the identifier for this property.
const AType & value -The value for this property.
TPropertyID::EvalueFilter filter =TPropertyID::kMonomorphicValues -See TPropertyID::EValueFilter.
const TPropertyFor < AType > & copy -The property to copy.
const TProperty & right -The property to downcast and copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.
Throws TTypeMismatch when the argument cannot be converted to TPropertyFor < AType >.
Throws no exceptions, passes all exceptions through.
Throws no exceptions, passes all exceptions through.
Throws no exceptions, passes all exceptions through.
Throws no exceptions, passes all exceptions through.
Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertyFor::operator=

TPropertyFor < AType > & operator =(const TPropertyFor < AType > & right)
TPropertyFor < AType > & operator =(const TProperty & right)

Interface Category:

API.

Purpose:

Assigns the contents of the argument to this object.
Determines if the type of its argument is equivalent to the type of this object, and if so, assigns the contents of the argument to this object.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

const TPropertyFor < AType > & right -The property to assign to this object.
const TProperty & right -The property 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.
Throws TTypeMismatch when the argument cannot be converted to TPropertyFor < AType >.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertyFor::~TPropertyFor

~ TPropertyFor ()

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: TPropertyFor::GetID

TPropertyIDFor < AType > GetID () const

Interface Category:

API.

Purpose:

Returns the property identifier.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The identifier of this property.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertyFor::CopyValue

AType * CopyValue () const

Interface Category:

API.

Purpose:

Returns a copy of the property value.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A copy of the property value.

Exceptions:

Throws TInvalidValue if no value exists.

Concurrency:

Not multithread safe.

Other Considerations:

Use this function, rather than GetValue, when you want to allow polymorphism.

Member Function: TPropertyFor::operatorTPropertyIDFor<AType>

operator TPropertyIDFor < AType > () const

Interface Category:

API.

Purpose:

Extracts the identifier from this property. This is a conversion operator that allows this object to be passed to functions which take a TPropertyIDFor < AType >.

Calling Context:

Called implicitly by the compiler whenever this object is passed to a function which takes a TPropertyIDFor < AType >. Called explicitly when this object is cast to a TPropertyIDFor < AType >.

Parameters:

Takes no parameters.

Return Value:

A reference to an instance of TPropertyIDFor < AType > const.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPropertyFor::operator!=

bool operator != (const TPropertyIDFor < AType > & right) const
bool operator != (const TPropertyFor < AType > & right) const

Interface Category:

API.

Purpose:

Determines if the id contained in this property is equal to its argument.
Determines if this property is equal to its argument.

Calling Context:

Called to test the equivalence of two objects.
Called to test the equivalence of two objects.

Parameters:

const TPropertyIDFor < AType > & right -The id to compare to this object.
const TPropertyFor < AType > & right -The property to compare to this object.

Return Value:

Returns true if the objects are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None

Member Function: TPropertyFor::operator==

bool operator ==(const TPropertyIDFor < AType > & right) const
bool operator ==(const TPropertyFor < AType > & right) const

Interface Category:

API.

Purpose:

Determines if the id contained in this property is not equal to its argument.
Determines if this property is not equal to its argument.

Calling Context:

Called to test the equivalence of two objects.
Called to test the equivalence of two objects.

Parameters:

const TPropertyIDFor < AType > & right -The id to compare to this object.
const TPropertyFor < AType > & right -The property to compare to this object.

Return Value:

Returns true if the objects are not equal.

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.