Class: TPresenterStateReference

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

None.

Purpose:

Provides a simple reference to the presenter state instance. If the referenced presenter state is persistent, this reference is valid across multiple sessions of the document. The reference can be used to look up the presenter state.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TPresenterStateReference::TPresenterStateReference

  1. TPresenterStateReference (const TModelPresenterState &)
  2. TPresenterStateReference (const TPresenterStateReference &)
  3. TPresenterStateReference ()

Interface Category:

API.

Purpose:

  1. Constructs a reference for a specific presenter state.
  2. Copy constructor.
  3. Default constructor.

Calling Context:

  1. Call this function directly.
  2. Call this function directly.
  3. Called by the stream-in operators and to create an undefined reference.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateReference::~TPresenterStateReference

virtual ~ TPresenterStateReference ()

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: TPresenterStateReference::IsReferenceFor

bool IsReferenceFor (const TModelPresenterState &) const

Interface Category:

API.

Purpose:

Determines whether this reference is for a specific presenter state.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if this reference is for the presenter state.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateReference::IsDefined

bool IsDefined () const

Interface Category:

API.

Purpose:

Determines whether this reference is defined to refer to a presenter state.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if this reference is defined to refer to a presenter state.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateReference::operatorTDocumentReference

operator TDocumentReference () const

Interface Category:

API.

Purpose:

Converts this reference to a document reference.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns a reference to the document containing the presenter state this reference refers to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateReference::operator=

TPresenterStateReference & operator =(const TPresenterStateReference &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

Return Value:

Returns a 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: TPresenterStateReference::operator==

bool operator ==(const TPresenterStateReference &) const

Interface Category:

API.

Purpose:

Compares two reference objects for equality. The references are equal if they refer to the same presenter state. Two undefined references are not equal.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if the references are for the same presenter state.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateReference::operator!=

bool operator != (const TPresenterStateReference &) const

Interface Category:

API.

Purpose:

Compares two references for inequality. The references are not equal if they do not refer to the same presenter state, or if either or both are undefined.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns true if the references are not to the same presenter state.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateReference::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: TPresenterStateReference::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 a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TPresenterStateReference::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Speeds comparison.

Calling Context:

Called by collections when comparing objects.

Parameters:

Return Value:

Returns the integer hash value.

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.