Class: TTieredText

Declaration: TieredText.h

Taxonomy Categories:

Member Functions:

Interface Category:

Developer Tool Programmer Interface.

Inherits From:

TStandardText

Inherited By:

None.

Purpose:

A derived class of TStandardText that adds tier information. This tier information indicates the relative importance of each piece of text.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Most clients do not derive from TTieredText unless you want to override its default behavior. If deriving, override the assignment, the stream-in, and the stream-out operators. Do not override the SetTier and GetTier functions.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TTieredText::TTieredText

TTieredText ()
TTieredText (const TText &, ETier tier =kNormal)
TTieredText (const TTieredText & source)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Default constructor.
Constructor that takes the text and the optional tier.
Copy constructor.

Calling Context:

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

Parameters:

Takes no parameters.
const TText & -The text.
ETier tier =kNormal -The tier for the given text.
const TTieredText & source -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTieredText::~TTieredText

virtual ~ TTieredText ()

Interface Category:

Developer Tool Programmer Interface.

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

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

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & destination -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: TTieredText::operator<<=

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

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & source -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: TTieredText::SetTier

virtual ETier SetTier (ETier)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Sets the tier of this TTieredText object to the given tier.

Calling Context:

Called by Test framework or directly.

Parameters:

ETier - The Tier to which TTieredText is to be set.

Return Value:

Returns the old tier before the set.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTieredText::GetTier

ETier GetTier () const

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Returns the tier for this TTieredText.

Calling Context:

Called by Test framework or directly.

Parameters:

Takes no parameters.

Return Value:

Returns the tier for this TTieredText.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TTieredText::operator=

TTieredText & operator =(const TTieredText & source)
TText & operator =(const TText & source)
TStandardText & operator =(const TStandardText & source)

Interface Category:

Developer Tool Programmer Interface.

Purpose:

Assignment operator.
Assignment operator.
Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.
Called when a TText object is assigned to this object.
Called when a TStandardText object is assigned to this object.

Parameters:

const TTieredText & source -The right-hand side object.
const TText & source -The right-hand side TText object.
const TStandardText & source -The right-hand side TStandardText object.

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.