vtkPV4Foam::arrayRange Class Reference

Bookkeeping for GUI checklists and the multi-block organization. More...

Public Member Functions
	arrayRange (const char *name, const int blockNo=0)
int	block () const
	Return the block holding these datasets. More...
int	block (int blockNo)
	Assign block number, return previous value. More...
const char *	name () const
	Return block name. More...
int	start () const
	Return array start index. More...
int	end () const
	Return array end index. More...
int	size () const
	Return sublist size. More...
bool	empty () const
void	reset (const int startAt=0)
	Reset the size to zero and optionally assign a new start. More...
void	operator+= (const int n)
	Increment the size. More...

Private Attributes
const char *	name_
int	block_
int	start_
int	size_

Detailed Description

Bookkeeping for GUI checklists and the multi-block organization.

Definition at line 112 of file vtkPV4Foam.H.

Constructor & Destructor Documentation

arrayRange()

arrayRange ( const char *  name, const int  blockNo = 0  )

inline

Definition at line 121 of file vtkPV4Foam.H.

Member Function Documentation

block() [1/2]

int block ( ) const

inline

Return the block holding these datasets.

Definition at line 130 of file vtkPV4Foam.H.

References vtkPV4Foam::arrayRange::block_.

block() [2/2]

int block ( int  blockNo )

inline

Assign block number, return previous value.

Definition at line 136 of file vtkPV4Foam.H.

References vtkPV4Foam::arrayRange::block_.

name()

const char* name ( ) const

inline

Return block name.

Definition at line 144 of file vtkPV4Foam.H.

References vtkPV4Foam::arrayRange::name_.

start()

int start ( ) const

inline

Return array start index.

Definition at line 150 of file vtkPV4Foam.H.

References vtkPV4Foam::arrayRange::start_.

end()

int end ( ) const

inline

Return array end index.

Definition at line 156 of file vtkPV4Foam.H.

References vtkPV4Foam::arrayRange::size_, and vtkPV4Foam::arrayRange::start_.

size()

int size ( ) const

inline

Return sublist size.

Definition at line 162 of file vtkPV4Foam.H.

References vtkPV4Foam::arrayRange::size_.

empty()

bool empty ( ) const

inline

Definition at line 167 of file vtkPV4Foam.H.

References vtkPV4Foam::arrayRange::size_.

reset()

void reset ( const int  startAt = 0 )

inline

Reset the size to zero and optionally assign a new start.

Definition at line 173 of file vtkPV4Foam.H.

References vtkPV4Foam::arrayRange::size_, and vtkPV4Foam::arrayRange::start_.

operator+=()

void operator+= ( const int  n )

inline

Increment the size.

Definition at line 180 of file vtkPV4Foam.H.

References n, and vtkPV4Foam::arrayRange::size_.

Field Documentation

name_

const char* name_

private

Definition at line 114 of file vtkPV4Foam.H.

Referenced by vtkPV4Foam::arrayRange::name().

block_

int block_

private

Definition at line 115 of file vtkPV4Foam.H.

Referenced by vtkPV4Foam::arrayRange::block().

start_

int start_

private

Definition at line 116 of file vtkPV4Foam.H.

Referenced by vtkPV4Foam::arrayRange::end(), vtkPV4Foam::arrayRange::reset(), and vtkPV4Foam::arrayRange::start().

size_

int size_

private

Definition at line 117 of file vtkPV4Foam.H.

Referenced by vtkPV4Foam::arrayRange::empty(), vtkPV4Foam::arrayRange::end(), vtkPV4Foam::arrayRange::operator+=(), vtkPV4Foam::arrayRange::reset(), and vtkPV4Foam::arrayRange::size().

---

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

• applications/utilities/postProcessing/graphics/PV4Readers/PV4FoamReader/vtkPV4Foam/vtkPV4Foam.H