Class: TParameterFormatResult

Declaration: Formatter.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TFormatResult

Inherited By:

None.

Purpose:

Returns information about how accurately a TFormattableParameterList was formatted.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

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

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TParameterFormatResult::TParameterFormatResult

TParameterFormatResult ()
TParameterFormatResult (const TParameterFormatResult & result)

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 TParameterFormatResult & result -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterFormatResult::~TParameterFormatResult

virtual ~ TParameterFormatResult ()

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

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

Interface Category:

API.

Purpose:

Takes the TFormatResult 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 formatting.

Parameters:

ParameterIndex aParameterNumber -The index of the parameter this format result applies to.
const TFormatResult& result -A reference to the format result for that parameter.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterFormatResult::GetParameterResult

virtual bool GetParameterResult (ParameterIndex aParameterNumber, TFormatResult & result)

Interface Category:

API.

Purpose:

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

Calling Context:

Called to get the format result for a particular parameter.

Parameters:

ParameterIndex aParameterNumber -The index of the parameter you want the format result for.
TFormatResult & result -Receives the format result for that parameter.

Return Value:

Returns true if a format result exists for this parameter.

Exceptions:

Throws an exception if the TFormatResult provided is not the same as or derived from the TFormatResult in the TParameterFormatResult.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterFormatResult::CopyParameterResult

virtual TFormatResult * CopyParameterResult (ParameterIndex aParameterNumber) const

Interface Category:

API.

Purpose:

Clones the TFormatResult 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 format result for that index.

Calling Context:

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

Parameters:

ParameterIndex aParameterNumber -The index of the parameter you want the format result for.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TParameterFormatResult::operator=

virtual TParameterFormatResult & operator =(const TParameterFormatResult & toCopy)
virtual TFormatResult & operator =(const TFormatResult & toCopy)

Interface Category:

API.

Purpose:

Assignment operator.
Assignment operator.

Calling Context:

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

Parameters:

const TParameterFormatResult & toCopy -The source object for the assignment.
const TFormatResult & 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.

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