Open CASCADE Technology  7.1.0.beta
Public Member Functions

Bnd_Range Class Reference

This class describes a range in 1D space restricted by two real values. A range can be void indicating there is no point included in the range. More...

#include <Bnd_Range.hxx>

Public Member Functions

 Bnd_Range ()
 Default constructor. Creates VOID range. More...
 
 Bnd_Range (const Standard_Real theMin, const Standard_Real theMax)
 Constructor. Never creates VOID range. More...
 
void Common (const Bnd_Range &theOther)
 Replaces <this> with common-part of <this> and theOther. More...
 
void Add (const Standard_Real theParameter)
 Extends <this> to include theParameter. More...
 
Standard_Boolean GetMin (Standard_Real &thePar) const
 Obtain MIN boundary of <this>. If <this> is VOID the method returns false. More...
 
Standard_Boolean GetMAX (Standard_Real &thePar) const
 Obtain MAX boundary of <this>. If <this> is VOID the method returns false. More...
 
Standard_Real Delta () const
 Returns range value (MAX-MIN). Returns negative value for VOID range. More...
 
Standard_Boolean IsVoid () const
 Is <this> initialized. More...
 
void SetVoid ()
 Initializes <this> by default parameters. Makes <this> VOID. More...
 
void Enlarge (const Standard_Real theDelta)
 Extends this to the given value (in both side) More...
 

Detailed Description

This class describes a range in 1D space restricted by two real values. A range can be void indicating there is no point included in the range.

Constructor & Destructor Documentation

Bnd_Range::Bnd_Range ( )
inline

Default constructor. Creates VOID range.

Bnd_Range::Bnd_Range ( const Standard_Real  theMin,
const Standard_Real  theMax 
)
inline

Constructor. Never creates VOID range.

Member Function Documentation

void Bnd_Range::Add ( const Standard_Real  theParameter)
inline

Extends <this> to include theParameter.

void Bnd_Range::Common ( const Bnd_Range theOther)

Replaces <this> with common-part of <this> and theOther.

Standard_Real Bnd_Range::Delta ( ) const
inline

Returns range value (MAX-MIN). Returns negative value for VOID range.

void Bnd_Range::Enlarge ( const Standard_Real  theDelta)
inline

Extends this to the given value (in both side)

Standard_Boolean Bnd_Range::GetMAX ( Standard_Real thePar) const
inline

Obtain MAX boundary of <this>. If <this> is VOID the method returns false.

Standard_Boolean Bnd_Range::GetMin ( Standard_Real thePar) const
inline

Obtain MIN boundary of <this>. If <this> is VOID the method returns false.

Standard_Boolean Bnd_Range::IsVoid ( ) const
inline

Is <this> initialized.

void Bnd_Range::SetVoid ( )
inline

Initializes <this> by default parameters. Makes <this> VOID.


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