Class: TDocumentComponentReadEntry

Declaration: CompoundDocument.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TDocumentComponentWriteEntry

Purpose:

This is a hierarchical component read lock. It locks the entire component, all of the component's children, and all of the component's ancestors for reading. A TDocumentComponentReadEntry must be created on a component before attempting to obtain a const pointer to a model or a presenter state.

Instantiation:

Always allocate on the stack.

Deriving Classes:

Do not derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TDocumentComponentReadEntry::TDocumentComponentReadEntry

TDocumentComponentReadEntry (const TDocumentComponentReference &)
TDocumentComponentReadEntry (const TModelReference &)
TDocumentComponentReadEntry (const TPresenterStateReference &)
TDocumentComponentReadEntry ()

Interface Category:

API.

Purpose:

Locks the specified component for reading.

Calling Context:

Call this function directly.

Parameters:

const TDocumentComponentReference & -The component to lock.
const TModelReference & -The unique model inside the component that is to be locked.
const TPresenterStateReference & -The unique presenter state inside the component that is to be locked.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

The default constructor is protected.

Member Function: TDocumentComponentReadEntry::~TDocumentComponentReadEntry

~ TDocumentComponentReadEntry ()

Interface Category:

API.

Purpose:

Destructor. Releases the lock on the component.

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: TDocumentComponentReadEntry::Init

void Init (const TDocumentComponentReference &)
void Init (const TModelReference &)
void Init (const TPresenterStateReference &)

Interface Category:

API.

Purpose:

Locks the specified document component reference.
Locks the specified model reference.
Locks the specified presenter state reference.

Calling Context:

Derived classes can call this function directly.
Derived classes can call this function directly.
Derived classes can call this function directly.

Parameters:

const TDocumentComponentReference & -The document component reference to lock.
const TModelReference & -The model reference to lock.
const TPresenterStateReference & -The presenter state reference to lock.

Return Value:

None.

Exceptions:

Throws TCompoundDocumentException::kDocumentComponentDoesNotExist if the document component does not exist.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

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