Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
Message_ProgressScale Class Reference

Internal data structure for scale in ProgressIndicator

Basically it defines three things:
More...

#include <Message_ProgressScale.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC Message_ProgressScale ()
 Creates scale ranged from 0 to 100 with step 1

void SetName (const Standard_CString theName)
void SetName (const Handle< TCollection_HAsciiString > &theName)
 Sets scale name

Handle_TCollection_HAsciiString GetName () const
 Gets scale name
Name may be Null handle if not set

void SetMin (const Standard_Real theMin)
 Sets minimum value of scale

Standard_Real GetMin () const
 Gets minimum value of scale

void SetMax (const Standard_Real theMax)
 Sets minimum value of scale

Standard_Real GetMax () const
 Gets minimum value of scale

void SetRange (const Standard_Real min, const Standard_Real max)
 Set both min and max

void SetStep (const Standard_Real theStep)
 Sets default step

Standard_Real GetStep () const
 Gets default step

void SetInfinite (const Standard_Boolean theInfinite=Standard_True)
 Sets flag for infinite scale

Standard_Boolean GetInfinite () const
 Gets flag for infinite scale

void SetScale (const Standard_Real min, const Standard_Real max, const Standard_Real step, const Standard_Boolean theInfinite=Standard_True)
 Set all scale parameters

void SetSpan (const Standard_Real first, const Standard_Real last)
 Defines span occupied by the scale on the basis scale

Standard_Real GetFirst () const
Standard_Real GetLast () const
 Return information on span occupied by the scale on the base scale

Standard_Real LocalToBase (const Standard_Real val) const
Standard_Real BaseToLocal (const Standard_Real val) const
 Convert value from this scale to base one and back


Detailed Description

     - name that can be used for generating user messages <br>
     - limits and characteristics of the current scale, <br>
       along with derived coefficients to map it into basic scale [0-1] <br>
     - methods for conversion of values from current scale <br>
       to basic one and back <br>


NOTE: There is no special protection against bad input data
like min > max etc. except cases when it can cause exception


Constructor & Destructor Documentation


Member Function Documentation

Handle_TCollection_HAsciiString Message_ProgressScale::GetName ( ) const

The documentation for this class was generated from the following file: