// $Revision: 1.5 $
// Copyright (C) 1995 Taligent, Inc. All rights reserved.
#if 0
---------------------------------------------------------------------------
> Class:
 | TGraphRange  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser:Graphing Framework  
> Interface Category:
 | Sample.  
> Inherits From:
 | None. 
> Inherited By:
 | None. 
> Purpose:
 | Defines a range along the axis of a graph. It makes sure that the minimum value is always less than or equal to the maximum value.  
> Instantiation:
 | Allocate on the heap or the stack.  
> Deriving Classes:
 | None.  
> Concurrency:
 | _Not_ multithread safe.  
> Resource Use:
 | No special requirements.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::TGraphRange ;
 | 1. TGraphRange ()  
 | 2. TGraphRange (GraphValue min, GraphValue max)  
 | 3. TGraphRange (const TGraphRange & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | 1. Default constructor.  
 | 2. Sets the minimum and maximum values. The minimum cannot be larger than the the maximum.  
 | 3. Copy constructor.  
> Calling Context:
 | 1. Called by the stream-in operators and anyone who wants a range of zero-to-zero.  
 | 2. Called by most clients. Sets the minimum and maximum appropriately.  
 | 3. Called to copy an object.  
> Parameters:
 = 1. Takes no parameters.  
 = 2. GraphValue min -The minimum value of the range.  
 = 2. GraphValue max -The maximum value of the range.  
 = 3. const TGraphRange & source -The TGraphRange to be copied.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::operator =;
 | TGraphRange & operator =(const TGraphRange & source)  
> Interface Category:
 | Sample.  
> Purpose:
 | Assignment operator.  
> Calling Context:
 | Called when an object is assigned to another compatible object.  
> Parameters:
 = const TGraphRange & source -TGraphRange to be copied.  
> 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: TGraphRange::operator >>=;
 | 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: TGraphRange::operator <<= ;
 | 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: TGraphRange::IsEmpty ;
 | bool IsEmpty () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Tests whether the range is empty --that is, min ==max.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | A Boolean indicating whether the range is empty (true) or not (false).  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::Contains ;
 | bool Contains (GraphValue value) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Tests to see if a value is within this range.  
> Calling Context:
 | None.  
> Parameters:
 = GraphValue value -The value that is being checked to see if it is contained in the range.  
> Return Value:
 | Returns true if the value is in the range.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::GetLength ;
 | GraphValue GetLength () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the range of the minimum and maximum values. If the range goes from 25 to 75, GetLength returns 50.  
> Calling Context:
 | None.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns a GraphValue that is the range of the minimum and maximum values.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::SetMinAndMax ;
 | void SetMinAndMax (GraphValue min, GraphValue max)  
> Interface Category:
 | Sample.  
> Purpose:
 | Sets both the minimum and the maximum of the range. Orders the values so that min is always less than or equal to max.  
> Calling Context:
 | Call this function directly.  
> Parameters:
 = GraphValue min -The minimum value of the range.  
 = GraphValue max -The maximum value of the range.  
> Return Value:
 | None.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::GetMax ;
 | GraphValue GetMax () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the maximum value of the range.  
> Calling Context:
 | None.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the maximum value of the range.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::GetMin ;
 | GraphValue GetMin () const  
> Interface Category:
 | Sample.  
> Purpose:
 | Returns the minimum value of the range.  
> Calling Context:
 | None.  
> Parameters:
 = Takes no parameters.  
> Return Value:
 | Returns the minimum value of the range.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::operator ==;
 | bool operator ==(const TGraphRange & other) const  
> Interface Category:
 | Sample.  
> Purpose:
 | Tests whether this object is equal to another TGraphRange object.  
> Calling Context:
 | Usually called by a comparator object. You can also call this function directly.  
> Parameters:
 = const TGraphRange & other -The object that is being checked to see if it is equal to this one.  
> Return Value:
 | Returns true if the other object is semantically equal to this one.  
> Exceptions:
 | Throws no exceptions, passes all exceptions through.  
> Concurrency:
 | _Not_ multithread safe.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif
#if 0
---------------------------------------------------------------------------
> Member Function: TGraphRange::~ TGraphRange ;
 | ~ TGraphRange ()  
> 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
---------------------------------------------------------------------------
> Typedef:
 | typedef double GraphValue  
> Taxonomy Category:
 | Documented Samples  
 | Stock Browser  
> Interface Category:
 | Sample.  
> Purpose:
 | Defines what data type the coordinate system uses. If a client wanted to port this Graphing framework to another system that only had integer values as coordinates, it could set it here.  
> Other Considerations:
 | None.  
---------------------------------------------------------------------------
#endif