Class: TScanResult

Declaration: Formatter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TNumberScanResult TParameterScanResult

Purpose:

Contains information about how accurately something was parsed.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

All scan result classes should derive from TScanResult. Derived classes should contain scanning information that is specific for a particular formatter. Derived classes should also provide the virtual operator=.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TScanResult::TScanResult

TScanResult ()
TScanResult (const TScanResult & toCopy)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TScanResult & toCopy -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScanResult::~TScanResult

virtual ~ TScanResult ()

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

virtual TScanResult & operator =(const TScanResult & toCopy)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TScanResult & toCopy -The source object for the assignment.

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: TScanResult::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 is streamed 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: TScanResult::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 is streamed 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: TScanResult::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Generates a hash value.

Calling Context:

Called to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScanResult::GetConfidence

virtual EScanResult GetConfidence () const

Interface Category:

API.

Purpose:

Gets the confidence of the scanning operation.

Calling Context:

Called to query what the confidence of the scanning operation was.

Parameters:

Takes no parameters.

Return Value:

The EScanResult value indication of the confidence of the scanning operation.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScanResult::SetConfidence

virtual void SetConfidence (const EScanResult result)

Interface Category:

API.

Purpose:

Sets the confidence of the scanning operation.

Calling Context:

Called during the scanning operation.

Parameters:

const EScanResult result -The confidence of the scanning operation.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScanResult::GetLengthUsed

virtual unsigned long GetLengthUsed () const

Interface Category:

API.

Purpose:

Returns the number of characters parsed during the scanning operation.

Calling Context:

Called to query how much text was parsed.

Parameters:

Takes no parameters.

Return Value:

The number of characters parsed.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TScanResult::SetLengthUsed

virtual void SetLengthUsed (const unsigned long lengthUsed)

Interface Category:

API.

Purpose:

Sets the number of characters parsed.

Calling Context:

Called during the scanning operation.

Parameters:

const unsigned long lengthUsed -The number of characters parsed.

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.