// $Revision: 1.5 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | MStockDatabase  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Stock Server  
> Interface Category:
 | Sample.  
> Inherits From:
 | None. 
> Inherited By:
 | TStockDatabase 
> Purpose:
 | This class defines the protocol for interacting with the Stock Server. It is an abstract base class for the caller and dispatcher implementation classes.  
> Instantiation:
 | Abstract base class; do not allocate.  
> Deriving Classes:
 | Override the pure virtuals to add any other necessary functions.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MStockDatabase::MStockDatabase ;
 | 1. MStockDatabase ()  
 | 2. MStockDatabase (const MStockDatabase & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Copy constructor.  
> Calling Context:
 | 1. Called by derived classes.  
 | 2. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. const MStockDatabase & source -The object to copy.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MStockDatabase::~ MStockDatabase ;
 | virtual ~ MStockDatabase ()  
> Interface Category:
 | Sample.  
> 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.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MStockDatabase::CopyAvailableNames ;
 | virtual void CopyAvailableNames (TCollectionOf < TStandardText > & collectionToFill) 
> Interface Category:
 | Sample.  
> Purpose:
 | Copies the names of available stocks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = TCollectionOf < TStandardText > & collectionToFill -The collection to fill with stock names.
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | This is a pure virtual function.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MStockDatabase::CopyAllStocks ;
 | virtual void CopyAllStocks (TCollectionOf < TStockData > & collectionToFill) 
> Interface Category:
 | Sample.  
> Purpose:
 | Copies all available stocks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = TCollectionOf < TStockData > & collectionToFill -The collection to fill with stocks.
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | This is a pure virtual function.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MStockDatabase::CopyStock ;
 | virtual TStockData * CopyStock (const TStandardText & stockName)  
> Interface Category:
 | Sample.  
> Purpose:
 | Copies a particular stock.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = const TStandardText & stockName -The name of the stock to copy.  
> Return Value:
 | A TStockData object representing the given stock.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | This is a pure virtual function.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MStockDatabase::CopyStockData ;
 | virtual bool CopyStockData (const TStandardText & stockName, TCollectionOf < TStockDay > & collectionToFill, const TRangeOfDays & range =TRangeOfDays :: kAllDays) 
> Interface Category:
 | Sample.  
> Purpose:
 | Copies the data for a particular stock.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = const TStandardText & stockName -The name of the stock for which to copy data.  
 = TCollectionOf < TStockDay > & collectionToFill -The collection to fill with stock data.
 = const TRangeOfDays & range =TRangeOfDays :: kAllDays -The range of time for which to copy data.  
> Return Value:
 | Returns true if the function executed successfully and the given stock was a valid one, false otherwise.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | This is a pure virtual function.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MStockDatabase::GetTimeStamp ;
 | virtual TPseudoTimeStamp GetTimeStamp ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the time stamp of the set of available stocks.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | A TPseudoTimeStamp object.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: MStockDatabase::operator =;
 | MStockDatabase & operator =(const MStockDatabase & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const MStockDatabase & source -The object to copy.  
> 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.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Class:
 | TStockDatabase  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Stock Server  
> Interface Category:
 | Sample.  
> Inherits From:
 | MStockDatabase 
> Inherited By:
 | TStockServer 
 | TStockCaller 
> Purpose:
 | A class derived from MStockDatabase that adds streaming capabilities.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | Derived classes must override the pure virtual functions declared in MStockDatabase.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TStockDatabase::TStockDatabase ;
 | 1. TStockDatabase ()  
 | 2. TStockDatabase (const TStockDatabase & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Copy constructor.  
> Calling Context:
 | 1. Called by derived classes and to construct an object.  
 | 2. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. const TStockDatabase & source -The object to copy.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TStockDatabase::~ TStockDatabase ;
 | virtual ~ TStockDatabase ()  
> Interface Category:
 | Sample.  
> 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.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TStockDatabase::operator >>=;
 | virtual TStream & operator >>=(TStream & toStream) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Stream-out operator.  
> Calling Context:
 | Called to stream out data.  
> Parameters:
 = TStream & toStream -The stream the object streams itself 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.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TStockDatabase::operator <<= ;
 | virtual TStream & operator <<= (TStream & fromStream)  
> Interface Category:
 | Sample.  
> Purpose:
 | Stream-in operator.  
> Calling Context:
 | Called to stream in data.  
> Parameters:
 = TStream & fromStream -The stream the object streams itself 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.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TStockDatabase::operator =;
 | TStockDatabase & operator =(const TStockDatabase & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TStockDatabase & source -The object to copy.  
> 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.  
---------------------------------------------------------------------------
#endif