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

class MarkedRangeSet provides continuous set of ranges marked with flags

#include <IntTools_MarkedRangeSet.hxx>

Public Member Functions

DEFINE_STANDARD_ALLOC IntTools_MarkedRangeSet ()
 Empty constructor


 IntTools_MarkedRangeSet (const Standard_Real theFirstBoundary, const Standard_Real theLastBoundary, const Standard_Integer theInitFlag)
 build set of ranges which consists of one range with
boundary values theFirstBoundary and theLastBoundary


 IntTools_MarkedRangeSet (const IntTools_CArray1OfReal &theSortedArray, const Standard_Integer theInitFlag)
 Build set of ranges based on the array of progressive sorted values

Warning:
The constructor do not check if the values of array are not sorted
It should be checked before function invocation


void SetBoundaries (const Standard_Real theFirstBoundary, const Standard_Real theLastBoundary, const Standard_Integer theInitFlag)
 build set of ranges which consists of one range with
boundary values theFirstBoundary and theLastBoundary


void SetRanges (const IntTools_CArray1OfReal &theSortedArray, const Standard_Integer theInitFlag)
 Build set of ranges based on the array of progressive sorted values

Warning:
The function do not check if the values of array are not sorted
It should be checked before function invocation


Standard_Boolean InsertRange (const Standard_Real theFirstBoundary, const Standard_Real theLastBoundary, const Standard_Integer theFlag)
 Inserts a new range marked with flag theFlag
It replace the existing ranges or parts of ranges
and their flags.
Returns True if the range is inside the initial boundaries,
otherwise or in case of some error returns False


Standard_Boolean InsertRange (const IntTools_Range &theRange, const Standard_Integer theFlag)
 Inserts a new range marked with flag theFlag
It replace the existing ranges or parts of ranges
and their flags.
Returns True if the range is inside the initial boundaries,
otherwise or in case of some error returns False


Standard_Boolean InsertRange (const Standard_Real theFirstBoundary, const Standard_Real theLastBoundary, const Standard_Integer theFlag, const Standard_Integer theIndex)
 Inserts a new range marked with flag theFlag
It replace the existing ranges or parts of ranges
and their flags.
The index theIndex is a position where the range will be inserted.
Returns True if the range is inside the initial boundaries,
otherwise or in case of some error returns False


Standard_Boolean InsertRange (const IntTools_Range &theRange, const Standard_Integer theFlag, const Standard_Integer theIndex)
 Inserts a new range marked with flag theFlag
It replace the existing ranges or parts of ranges
and their flags.
The index theIndex is a position where the range will be inserted.
Returns True if the range is inside the initial boundaries,
otherwise or in case of some error returns False


void SetFlag (const Standard_Integer theIndex, const Standard_Integer theFlag)
 Set flag theFlag for range with index theIndex


Standard_Integer Flag (const Standard_Integer theIndex) const
 Returns flag of the range with index theIndex


Standard_Integer GetIndex (const Standard_Real theValue) const
 Returns index of range which contains theValue.
If theValue do not belong any range returns 0.


const TColStd_SequenceOfIntegerGetIndices (const Standard_Real theValue)
Standard_Integer GetIndex (const Standard_Real theValue, const Standard_Boolean UseLower) const
 Returns index of range which contains theValue
If theValue do not belong any range returns 0.
If UseLower is Standard_True then lower boundary of the range
can be equal to theValue, otherwise upper boundary of the range
can be equal to theValue.


Standard_Integer Length () const
 Returns number of ranges


IntTools_Range Range (const Standard_Integer theIndex) const
 Returns the range with index theIndex.
the Index can be from 1 to Length()



Constructor & Destructor Documentation


Member Function Documentation

void IntTools_MarkedRangeSet::SetBoundaries ( const Standard_Real  theFirstBoundary,
const Standard_Real  theLastBoundary,
const Standard_Integer  theInitFlag 
)

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