Class: TRecordFieldOf

Declaration: Record.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TRecordField

Inherited By:

None.

Purpose:

This template is for generic field wrappers. It is used for the following types: TRecordTTextField TRecordTTimeField TRecordTSQLTimeField TRecordTSQLDateField

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TRecordFieldOf::TRecordFieldOf

TRecordFieldOf ()
TRecordFieldOf (const AAbstractType & value)

Interface Category:

API.

Purpose:

Default constructor.
The standard field constructor that creates a field instance with the given value.

Calling Context:

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

Parameters:

Takes no parameters.
const AAbstractType & value -The initial value for the field instance.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRecordFieldOf::~TRecordFieldOf

virtual ~ TRecordFieldOf ()

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: TRecordFieldOf::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.

Member Function: TRecordFieldOf::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: TRecordFieldOf::operator=

TRecordFieldOfType & operator =(const TRecordFieldOfType & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function directly.

Parameters:

const TRecordFieldOfType & right -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: TRecordFieldOf::GetValue

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

Interface Category:

API.

Purpose:

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

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

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

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: TRecordFieldOf::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.

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