Classes | Public Member Functions | Friends | List of all members
labelRanges Class Reference

A list of labelRange. More...

Inheritance diagram for labelRanges:
Inheritance graph
[legend]
Collaboration diagram for labelRanges:
Collaboration graph
[legend]

Classes

class  const_iterator
 An STL const_iterator. More...
 

Public Member Functions

 labelRanges ()
 Construct null. More...
 
 labelRanges (const label)
 Construct given size. More...
 
 labelRanges (Istream &)
 Construct from Istream. More...
 
bool contains (const label) const
 Return true if the value is within any of the ranges. More...
 
bool add (const labelRange &)
 Add the range to the list. More...
 
bool remove (const labelRange &)
 Remove the range from the list. More...
 
const_iterator cbegin () const
 const_iterator set to the beginning of the list More...
 
const const_iterator & cend () const
 const_iterator set to beyond the end of the list More...
 
const_iterator begin () const
 const_iterator set to the beginning of the list More...
 
const const_iterator & end () const
 const_iterator set to beyond the end of the list More...
 

Friends

Istream & operator>> (Istream &, labelRanges &)
 
Ostream & operator<< (Ostream &, const labelRanges &)
 

Detailed Description

A list of labelRange.

Source files

Definition at line 58 of file labelRanges.H.

Constructor & Destructor Documentation

◆ labelRanges() [1/3]

labelRanges ( )
inline

Construct null.

Definition at line 29 of file labelRangesI.H.

◆ labelRanges() [2/3]

labelRanges ( const label  nElem)
inlineexplicit

Construct given size.

Definition at line 35 of file labelRangesI.H.

◆ labelRanges() [3/3]

labelRanges ( Istream &  is)

Construct from Istream.

Definition at line 120 of file labelRanges.C.

Member Function Documentation

◆ contains()

bool contains ( const label  value) const
inline

Return true if the value is within any of the ranges.

Definition at line 152 of file labelRangesI.H.

References forAll, and DynamicList< labelRange >::operator.

◆ add()

bool add ( const labelRange &  range)

Add the range to the list.

Definition at line 128 of file labelRanges.C.

References DynamicList< labelRange >::append(), labelRange::clear(), labelRange::empty(), UList< T >::empty(), forAll, labelRange::intersects(), UList< T >::operator[](), range, and List< T >::size().

Here is the call graph for this function:

◆ remove()

bool remove ( const labelRange &  range)

Remove the range from the list.

Definition at line 186 of file labelRanges.C.

References labelRange::debug, labelRange::empty(), UList< T >::empty(), Foam::endl(), labelRange::first(), forAll, Foam::Info, labelRange::last(), and UList< T >::operator[]().

Here is the call graph for this function:

◆ cbegin()

Foam::labelRanges::const_iterator cbegin ( ) const
inline

const_iterator set to the beginning of the list

Definition at line 126 of file labelRangesI.H.

References labelRanges::const_iterator::const_iterator().

Here is the call graph for this function:

◆ cend()

const Foam::labelRanges::const_iterator & cend ( ) const
inline

const_iterator set to beyond the end of the list

Definition at line 132 of file labelRangesI.H.

◆ begin()

Foam::labelRanges::const_iterator begin ( ) const
inline

const_iterator set to the beginning of the list

Definition at line 138 of file labelRangesI.H.

References labelRanges::const_iterator::const_iterator().

Here is the call graph for this function:

◆ end()

const Foam::labelRanges::const_iterator & end ( ) const
inline

const_iterator set to beyond the end of the list

Definition at line 144 of file labelRangesI.H.

Friends And Related Function Documentation

◆ operator>>

Istream& operator>> ( Istream &  ,
labelRanges &   
)
friend

◆ operator<<

Ostream& operator<< ( Ostream &  ,
const labelRanges &   
)
friend
The documentation for this class was generated from the following files: