Class: TParameterScanResult

Declaration: Formatter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TScanResult

Inherited By:

None.

Purpose:

Returns information about how accurately a TFormattableParameterList was scanned.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Any formatter derived from TParameterFormatter might want to create a scan result that derives from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TParameterScanResult::TParameterScanResult

  1. TParameterScanResult ()
  2. TParameterScanResult (const TParameterScanResult & result)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

  1. Called by the stream-in operators.
  2. Called to copy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterScanResult::~TParameterScanResult

virtual ~ TParameterScanResult ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterScanResult::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

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

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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: TParameterScanResult::SetParameterResult

virtual void SetParameterResult (ParameterIndex aParameterNumber, const TScanResult& result)

Interface Category:

API.

Purpose:

Takes the TScanResult for a given parameter, clones it, and puts it in the specified index. The storage for this function and the user's storage are totally independent.

Calling Context:

Called during scanning.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterScanResult::GetParameterResult

virtual bool GetParameterResult (ParameterIndex aParameterNumber, TScanResult & result)

Interface Category:

API.

Purpose:

Copies the value of the specified TScanResult in the TParameterScanResult to the storage area provided. The caller should provide the right kind of TScanResult object.

Calling Context:

Called to get the scan result for a particular parameter.

Parameters:

Return Value:

Returns true if a scan result exists for this parameter.

Exceptions:

Throws an exception if the TScanResult provided is not the same as or derived from the TScanResult in the TParameterScanResult.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterScanResult::CopyParameterResult

virtual TScanResult * CopyParameterResult (ParameterIndex aParameterNumber) const

Interface Category:

API.

Purpose:

Clones the TScanResult in the specified index, and returns a pointer to it. It is the caller's responsibility to delete this cloned object. A NIL pointer is returned if there is no scan result for that index.

Calling Context:

Called to get a copy of the scan result for a particular parameter.

Parameters:

Return Value:

A pointer to the scan result for the specified parameter. Returns a NIL pointer if there is no scan result.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterScanResult::ClearAllParameters

virtual void ClearAllParameters ()

Interface Category:

API.

Purpose:

Deletes all scan result objects attached to this object.

Calling Context:

Called before a new scanning operation. Call this function directly.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterScanResult::operator=

  1. virtual TParameterScanResult & operator =(const TParameterScanResult & toCopy)
  2. virtual TScanResult & operator =(const TScanResult & toCopy)

Interface Category:

API.

Purpose:

  1. Assignment operator.
  2. Assignment operator.

Calling Context:

  1. Called when an object is assigned to another compatible object.
  2. Called when an object is assigned to another compatible object.

Parameters:

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.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.