Diffpack Documentation

---

              Search  

---

ConvMonitorList_prm Class Reference

parameters for initializing a "ConvMonitorList" object. More...

#include <ConvMonitorList_prm.h>

Inheritance diagram for ConvMonitorList_prm::

List of all members.

Public Methods
	ConvMonitorList_prm (int nmonitors=1, bool allocate=true)
	~ConvMonitorList_prm ()
bool	redim (int nmonitors, bool allocate=true)
int	size () const
ConvMonitor_prm&	cmvec (int i=1)
const ConvMonitor_prm&	cmvec (int i=1) const
void	attach (const ConvMonitor_prm &cmprm, int i=1)
bool	ok () const
void	define (MenuSystem &menu, int level=MAIN)
void	scan (MenuSystem &menu)
void	print (Os os) const
Static Public Methods
void	allowMenuChanges ()
void	setMaxNoOfMonitors (int maxNoMonitors=1)
void	defineStatic (MenuSystem &menu, int level=MAIN)

---

Detailed Description

parameters for initializing a "ConvMonitorList" object.

NAME: ConvMonitorList_prm - parameters for initializing a "ConvMonitorList" object

DESCRIPTION:

The class contains a collection of "ConvMonitor_prm" objects that is used to initialize a list of "ConvMonitor"s.

---

Constructor & Destructor Documentation

ConvMonitorList_prm::ConvMonitorList_prm ( int nmonitors = 1, bool allocate = true )

The constructor takes optional arguments "nmonitors" and "allocate" for the number of "ConvMonitor_prm" objects and as allocation flag, respectively.

ConvMonitorList_prm::~ConvMonitorList_prm ( ) [inline]

---

Member Function Documentation

static void ConvMonitorList_prm::allowMenuChanges ( ) [inline, static]

tells the menu system that changes are allowed.

void ConvMonitorList_prm::attach ( const ConvMonitor_prm & cmprm, int i = 1 ) [inline]

attach a "ConvMonitor_prm" object in position "i".

const ConvMonitor_prm & ConvMonitorList_prm::cmvec ( int i = 1 ) const [inline]

See documentation of one of the overloaded functions.

ConvMonitor_prm & ConvMonitorList_prm::cmvec ( int i = 1 ) [inline]

return the "i"th "ConvMonitor_prm" object (can also be used for assignments).

void ConvMonitorList_prm::define ( MenuSystem & menu, int level = MAIN ) [inline]

initialize a submenu for each "ConvMonitor_prm" object.

static void ConvMonitorList_prm::defineStatic ( MenuSystem & menu, int level = MAIN ) [static]

static version of "define".

bool ConvMonitorList_prm::ok ( ) const

checks the state of the current object.

void ConvMonitorList_prm::print ( Os os ) const

prints the contents of the "ConvMonitor_prm" objects to an output stream.

bool ConvMonitorList_prm::redim ( int nmonitors, bool allocate = true )

redimensions the collection of "ConvMonitor_prm" objects. The objects are allocated if the "allocate" flag is "true".

void ConvMonitorList_prm::scan ( MenuSystem & menu )

scan data items from the menu system or an input stream.

static void ConvMonitorList_prm::setMaxNoOfMonitors ( int maxNoMonitors = 1 ) [static]

sets the maximum number of "ConvMonitor_prm" submenus.

int ConvMonitorList_prm::size ( ) const [inline]

returns the maximum number of "ConvMonitor_prm" objects.

---

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

• ConvMonitorList_prm.h

---