Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MCollectible
Inherited By:
None.
Purpose:
TStoreStreamer provides a standard mechanism for archiving TStore objects.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Do not derive from TStoreStreamer.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
TStoreStreamer ()
Interface Category:
API.
Purpose:
Default constructor.
Calling Context:
Called by the stream-in operators.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
~ TStoreStreamer ()
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:
Multithread safe.
Other Considerations:
None.
TStore * GetObject ()
Interface Category:
API.
Purpose:
Returns the TStore for which this object is a streamer. The TStore is set with the AdoptObject member function.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the TStore for which this object is a streamer.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TStoreStreamer::AdoptObject
void AdoptObject (TStore *)
Interface Category:
API.
Purpose:
Adopts the specified TStore as this object's current TStore. This function orphans the previously adopted TStore, if any.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TStoreStreamer::OrphanObject
TStore * OrphanObject ()
Interface Category:
API.
Purpose:
Orphans this streamer's current TStore.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the orphaned object.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Multithread safe.
Other Considerations:
None.
Member Function: TStoreStreamer::operator>>=
virtual TStream & operator >>=(TStream &) const
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: TStoreStreamer::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.
virtual long Hash () const
Interface Category:
API.
Purpose:
Overrides inherited MCollectible function to return hash value.
Calling Context:
Called by collection classes.
Parameters:
Return Value:
Returns hash value.
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.
Copyright©1995 Taligent,Inc. All rights reserved.