Class: TArgumentDictionaryLookupFailureException

Declaration: TextArgumentDictionary.h

Taxonomy Categories:

Member Functions:

Interface Category:

Developer Tool Programmer Interface.

Inherits From:

TStandardException

Inherited By:

None.

Purpose:

An exception thrown by TTextArgumentDictionary when a lookup fails.

Instantiation:

Always allocate on the stack.

Deriving Classes:

Used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TArgumentDictionaryLookupFailureException::~TArgumentDictionaryLookupFailureException

virtual ~ TArgumentDictionaryLookupFailureException ()

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Destructor. Performs no operation.

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

TArgumentDictionaryLookupFailureException & operator =(const TArgumentDictionaryLookupFailureException & other)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TArgumentDictionaryLookupFailureException & other -The object to be assigned.

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

virtual bool operator ==(const TStandardException & that) const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Compares the given exception with this exception.

Calling Context:

Called this function directly.

Parameters:

const TStandardException & that -The exception object to use in comparison.

Return Value:

Returns true if the given exception object is the same as this exception.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArgumentDictionaryLookupFailureException::operator<<=

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

Interface Category:

Developer Tool Programmer Interface.

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

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

Interface Category:

Developer Tool Programmer Interface.

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: TArgumentDictionaryLookupFailureException::GetMaxAllowed

double GetMaxAllowed () const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Returns the minimum allowed value for the number that is looked up.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the minimum allowed value for the number that is looked up.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArgumentDictionaryLookupFailureException::GetMinAllowed

double GetMinAllowed () const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Returns the maximum allowed value for the number that is looked up.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the maximum allowed value for the number that is looked up.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArgumentDictionaryLookupFailureException::GetParsedValue

double GetParsedValue () const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Returns the numeric value that is parsed from the value in the dictionary.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the numeric value that is parsed from the value in the dictionary.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArgumentDictionaryLookupFailureException::GetReason

ELookupError GetReason () const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Returns the reason why the lookup failed.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the reason why the lookup failed.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArgumentDictionaryLookupFailureException::GetActualValue

void GetActualValue (TText &) const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Get the actual TText value from the dictionary that was found in the lookup.

Calling Context:

Call this function directly.

Parameters:

TText & -The actual value from the dictionary that was found in the lookup.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArgumentDictionaryLookupFailureException::GetKey

void GetKey (TText &) const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Get the key that was used in the lookup.

Calling Context:

Call this function directly.

Parameters:

TText & -The key that was used in the lookup.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArgumentDictionaryLookupFailureException::Throw

virtual void Throw () const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Throws this exception object.

Calling Context:

Called when this exception is to be thrown.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TArgumentDictionaryLookupFailureException::TArgumentDictionaryLookupFailureException

TArgumentDictionaryLookupFailureException ()
TArgumentDictionaryLookupFailureException (const TArgumentDictionaryLookupFailureException & other)
TArgumentDictionaryLookupFailureException (ELookupError errorType, const TText * actualValue, double parsedValue, double minAllowed, double maxAllowed, const TText * key =NIL)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Default constructor.
Copy constructor.
Constructor that takes all the input data for the exception.

Calling Context:

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

Parameters:

Takes no parameters.
const TArgumentDictionaryLookupFailureException & other -The exception to be copied.
ELookupError errorType -The error that occurred in the lookup.
const TText * actualValue -The actual value found in the dictionary.
double parsedValue -The numeric value parsed using the actual value.
double minAllowed -The minimum allowed value.
double maxAllowed -The maximum allowed value.
const TText * key =NIL -The key that was used for the lookup.

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.