Class: TRecordFieldHandleOf

Declaration: Record.h

Taxonomy Categories:

Member Functions:

TRecordFieldHandleOf
~TRecordFieldHandleOf
operator=
GetValue
SetValue
Replace

Interface Category:

API.

Inherits From:

TRecordFieldHandle

Inherited By:

None.

Purpose:

This template is for generic field handle wrappers. For instance, it can be used for TRecordTTextFieldHandle.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TRecordFieldHandle.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRecordFieldHandleOf::TRecordFieldHandleOf

TRecordFieldHandleOf ()
TRecordFieldHandleOf (const TRecordFieldHandleOfType & fieldHandle)
TRecordFieldHandleOf (const TRecordFieldHandle & fieldHandle)

Interface Category:

API.

Purpose:

Default constructor.
The constructor that creates a field handle for the given field.
The constructor that creates a field handle for the given field.

Calling Context:

Called by the stream-in operators and any other function that needs to construct an uninitialized object.
Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
const TRecordFieldHandleOfType & fieldHandle -The handle of the field to copy.
const TRecordFieldHandle & fieldHandle -The handle of the field to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordFieldHandleOf::~TRecordFieldHandleOf

virtual ~ TRecordFieldHandleOf ()

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: TRecordFieldHandleOf::operator=

TRecordFieldHandleOfType & operator =(const TRecordFieldHandleOfType & fieldHandle)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TRecordFieldHandleOfType & fieldHandle -The field to copy.

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: TRecordFieldHandleOf::GetValue

virtual AConcreteType GetValue () const
virtual const AAbstractType & GetValue (AAbstractType & target) const

Interface Category:

API.

Purpose:

Returns the value of the field by value.
Returns the value of the field by reference.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
AAbstractType & target -On return, holds the value of the field.

Return Value:

The value of the field, or a const reference to the value of the field.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordFieldHandleOf::SetValue

virtual void SetValue (const AAbstractType & value)

Interface Category:

API.

Purpose:

Sets the value of the field.

Calling Context:

Call this function directly.

Parameters:

const AAbstractType & value -The new value for the field.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordFieldHandleOf::Replace

virtual void Replace (const TRecordFieldHandle & field)

Interface Category:

API.

Purpose:

Replaces the field with the value from the given field.

Calling Context:

Call this function directly.

Parameters:

const TRecordFieldHandle & field -The field that replaces the current field.

Return Value:

None.

Exceptions:

Raises an exception if the given field is incompatible.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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