Class: TDocumentComponentStore

Declaration: CompoundDocumentStorage.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStore

Inherited By:

None.

Purpose:

TDocumentComponentStore is a TStore derived class used for storing document components. It provides default storage bins for the presenter state and the model of a document component.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Concurrency:

Multithread safe. This class enforces multiple readers or single writer semantics by delegating concurrency control to its storage mechanism.

Resource Use:

This class is responsible for managing its own resources.

Other Considerations:

Invariants: Assertion (fStorageMechanism != NIL).

Member Function: TDocumentComponentStore::TDocumentComponentStore

TDocumentComponentStore (TMultiBinStorageMechanism *)
TDocumentComponentStore ()
TDocumentComponentStore (const TDocumentComponentStore &)

Interface Category:

API.

Interface Category:

API.

Purpose:

Creates a document component store with the given storage mechanism.
Default constructor. Used to resurrect a flattened document component store instance.
Copy constructor.

Calling Context:

Called to create a document component store with the given storage mechanism.
Only for internal use by Resurrect. Developers should treat as protected.
Called to copy an object. Only for internal use by Copy. Developers should treat as protected.

Parameters:

TStorageMechanism * -The storage mechanism to be adopted by the store.
Takes no parameters.
const TDocumentStore & -The store to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

The default and copy constructors are protected.

Member Function: TDocumentComponentStore::~TDocumentComponentStore

virtual ~ TDocumentComponentStore ()

Interface Category:

API.

Purpose:

Destructor. Releases the storage mechanism resource. If the previous access mode is read-write, then others now have access. Otherwise, nothing changes.

Calling Context:

Called to destroy an object. This function is called automatically by a TDocumentComponent destructor, such as when a document component object is destroyed.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::CreateIn

virtual void CreateIn (TDocumentStore& )

Interface Category:

API.

Purpose:

Creates the underlying physical storage mechanism underneath the specified parent store.

Calling Context:

Call this function directly.

Parameters:

TDocumentStore & -The parent document store.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::Create

virtual void Create ()

Interface Category:

API.

Purpose:

Creates the underlying physical storage mechanism.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::Delete

virtual void Delete ()

Interface Category:

API.

Purpose:

Deletes the underlying physical storage mechanism.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::ResurrectFromLastCommit

virtual void ResurrectFromLastCommit (TModelPresenterState * &)
virtual void ResurrectFromLastCommit (TModel * &)

Interface Category:

API.

Purpose:

Resurrects the presenter state for a document component.
Resurrects the model for a document component.

Calling Context:

Called to resurrect the presenter state.
Called to resurrect the model.

Parameters:

TModelPresenterState * & -The memory address for resurrecting the presenter state.
TModel * & -The memory address for resurrecting the model.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Postcondition:
Postcondition:

Member Function: TDocumentComponentStore::Commit

virtual void Commit (const TModelPresenterState &)
virtual void Commit (const TModel &)

Interface Category:

API.

Purpose:

Commits the presenter state of a document component.
Commits the model of a document component.

Calling Context:

Called to commit the presenter state.
Called to commit the model.

Parameters:

const TModelPresenterState & -The presenter state to commit.
const TModel & -The model to commit.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

Postcondition:
Postcondition:

Member Function: TDocumentComponentStore::operator>>=

TStream

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream to which the object streams itself out.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream from which the object streams itself in.

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:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::operator=

TDocumentComponentStore & operator =(const TDocumentComponentStore &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TDocumentComponentStore & -The right-hand side object.

Return Value:

Returns a const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::AdoptStorageMechanism

void AdoptStorageMechanism (TMultiBinStorageMechanism *)

Interface Category:

API.

Purpose:

Allows a new mechanism to be adopted into the store.

Calling Context:

Call this function directly.

Parameters:

TMultiBinStorageMechanism * -The storage mechanism to adopt.

Return Value:

None

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::GetStorageMechanism

TMultiBinStorageMechanism * GetStorageMechanism ()
const TMultiBinStorageMechanism * GetStorageMechanism () const

Interface Category:

API.

Purpose:

Returns a pointer to this store's underlying storage mechanism.
Returns a const pointer to this store's underlying storage mechanism.

Calling Context:

Call this function directly.
Call this function directly.

Parameters:

Takes no parameters.
Takes no parameters.

Return Value:

Returns a pointer to this store's underlying storage mechanism.
Returns a const pointer to this store's underlying storage mechanism.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TDocumentComponentStore::CopyStoreAliasFor

static TDocumentComponentStore * CopyStoreAliasFor (const TDocumentComponentReference &)
static TDocumentComponentStore * CopyStoreAliasFor (const TModelReference &)
static TDocumentComponentStore * CopyStoreAliasFor (const TPresenterStateReference &)

Interface Category:

API.

Purpose:

Looks up and makes a copy of the store used to store the specified document component. The copy is then returned to the caller.
Looks up and makes a copy of the store used to store the specified model. The copy is then returned to the caller.
Looks up and makes a copy of the store used to store the specified presenter state. The copy is then returned to the caller.

Calling Context:

Call this function directly.
Call this function directly.
Call this function directly.

Parameters:

const TDocumentComponentReference & -The document component reference whose store is to be copied.
const TModelReference & -The model reference whose store is to be copied.
const TPresenterStateReference & -The presenter state reference whose store is to be copied.

Return Value:

Returns the newly created copy of the store for the specified object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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