// $Revision: 1.5 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TLocalStockData  
> Taxonomy Category:
 | Documented Samples  
 | StockBrowser: Stock Server  
> Interface Category:
 | Sample.  
> Inherits From:
 | TStockData 
> Inherited By:
 | None. 
> Purpose:
 | Represents all of the data for a particular stock. It owns a collection of TStockDay objects for this purpose.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | No special instructions.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TLocalStockData::TLocalStockData ;
 | 1. TLocalStockData ()  
 | 2. TLocalStockData (const TLocalStockData & source)  
 | 3. TLocalStockData (const TStandardText & name, TCollectionOf < TStockDay > * adoptedData =NIL) 
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Copy constructor.  
 | 3. Standard constructor.  
> Calling Context:
 | 1. Called by the stream-in operators and derived classes.  
 | 2. Called to copy an object.  
 | 3. Called to construct an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. const TLocalStockData & source -The object to copy.  
 = 3. const TStandardText & name -The name of the stock represented by this object.  
 = 3. TCollectionOf < TStockDay > * adoptedData =NIL -The stock data. If adoptedData ==NIL, the stock data is effectively empty.
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TLocalStockData::~ TLocalStockData ;
 | virtual ~ TLocalStockData ()  
> Interface Category:
 | Sample.  
> Purpose:
 | Destructor.  
> Calling Context:
 | Called to destroy an object. Deletes the collection of data.  
> 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: TLocalStockData::operator =;
 | 1. TLocalStockData & operator =(const TLocalStockData & source)  
 | 2. virtual TLocalStockData & operator =(const TStockData & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Assignment operator.  
 | 2. Polymorphic assignment operator.  
> Calling Context:
 | 1. Called when an object is assigned to another compatible object.  
 | 2. Called to copy a sibling object's data into this object.  
> Parameters:
 = 1. const TLocalStockData & source -The object from which to copy data.  
 = 2. const TStockData & source -The object from which to copy data.  
> 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
---------------------------------------------------------------------------
> Member Function: TLocalStockData::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: TLocalStockData::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: TLocalStockData::operator ==;
 | virtual bool operator ==(const TStockData & other) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Tests the equality of two objects.  
> Calling Context:
 | Called to compare two objects.  
> Parameters:
 = const TStockData & other -The object to compare to.  
> Return Value:
 | A boolean value of true if the objects compare equal, false otherwise.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TLocalStockData::CopyData ;
 | virtual bool CopyData (TCollectionOf < TStockDay > & fillWithStockData, const TRangeOfDays & range =TRangeOfDays :: kAllDays) const
> Interface Category:
 | Sample.  
> Purpose:
 | Copies stock data for a given range of time into a collection.  
> Calling Context:
 | Called to retrieve stock data.  
> Parameters:
 = TCollectionOf < TStockDay > & fillWithStockData -The collection to fill with stock data.
 = const TRangeOfDays & range =TRangeOfDays :: kAllDays -The range of time to copy data for.  
> Return Value:
 | Returns true if the copy operation was successful.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TLocalStockData::AdoptData ;
 | virtual void AdoptData (TCollectionOf < TStockDay > * dataToAdopt) 
> Interface Category:
 | Sample.  
> Purpose:
 | Sets or replaces the stock data owned by the object.  
> Calling Context:
 | Called to adopt a new collection of TStockDay objects into the TLocalStockData object.  
> Parameters:
 = TCollectionOf < TStockDay > * dataToAdopt -The collection of stock data to adopt.
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TLocalStockData::OrphanData ;
 | virtual TCollectionOf < TStockDay > * OrphanData () 
> Interface Category:
 | Sample.  
> Purpose:
 | Releases ownership of the collection of stock data.  
> Calling Context:
 | Called to orphan the TLocalStockData object's collection of stock data.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | A pointer to a TCollectionOf< TStockDay > containing the stock's data.
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif