vlVarListAdmin Class Reference

This is like an administrator class for vlNameValueContainer. More...

#include <vlvarlistadmin.h>

Inheritance diagram for vlVarListAdmin:

List of all members.

Public Member Functions
	vlVarListAdmin ()
	~vlVarListAdmin ()
bool	add (const vlDataType datatype, const std::string &name, const std::string &desc="No Description", const bool valid=false)
	Add a variable to the list such that it can only be removed by this class (the admin class).
template<class DataType> bool	add (DataType &def, const std::string &name, const std::string &desc="No Description", const bool valid=false)
	Add a variable to the list such that it can only be removed by this class (the admin class).
template<class DataType> bool	add (DataType &def, const std::list< DataType > &validValues, const std::string &name, const std::string &desc="No Description", bool valid=false)
	Same as above, but this lets you set a list of valid values for the variable.
template<class DataType> bool	add (DataType &def, const DataType &lowerBound, const DataType &upperBound, const std::string &name, const std::string &desc="No Description", bool valid=false)
	Same as above, but this lets you set a range of valid values for the variable.
void	clear (bool all=true)
	Clear all the variables stored.
vlVarListAdmin &	operator= (const vlVarList &other)
	Copy operator overloading.
vlVarListAdmin &	operator= (const vlVarListAdmin &other)
	Copy operator overloading.

---

Detailed Description

If you want to provide name-value container with controlled access to add, clear, etc. then create object of this class and then provide pointer of type vlNameValueContainer to the users. This way, user won't be able to remove name-value variables added by you, the admin.

Definition at line 40 of file vlvarlistadmin.h.

---

Constructor & Destructor Documentation

vlVarListAdmin::vlVarListAdmin (   )

Definition at line 33 of file vlvarlistadmin.cpp.

vlVarListAdmin::~vlVarListAdmin (   )

Definition at line 38 of file vlvarlistadmin.cpp. References vlVarList::clear().

---

Member Function Documentation

template<class DataType> bool vlVarListAdmin::add (  DataType &  def, const DataType &  lowerBound, const DataType &  upperBound, const std::string &  name, const std::string &  desc = "No Description", bool  valid = false )

Reimplemented from vlVarList. Definition at line 114 of file vlvarlistadmin.h. References vlVarList::adminVarListRW(), and name.

template<class DataType> bool vlVarListAdmin::add (  DataType &  def, const std::list< DataType > &  validValues, const std::string &  name, const std::string &  desc = "No Description", bool  valid = false )

Reimplemented from vlVarList. Definition at line 103 of file vlvarlistadmin.h. References vlVarList::adminVarListRW(), and name.

template<class DataType> bool vlVarListAdmin::add (  DataType &  def, const std::string &  name, const std::string &  desc = "No Description", const bool  valid = false )

Reimplemented from vlVarList. Definition at line 93 of file vlvarlistadmin.h. References vlVarList::adminVarListRW(), and name.

bool vlVarListAdmin::add (  const vlDataType  datatype, const std::string &  name, const std::string &  desc = "No Description", const bool  valid = false )

Reimplemented from vlVarList. Definition at line 57 of file vlvarlistadmin.cpp. References add(), callFunctionOnDataType, and name. Referenced by add(), GaussianApprox::computeApproxGaussBlur(), vlVolProcessorDilate::dilate(), vlVolProcessorErode::erode(), vlVolProcessorThresh::init(), vlVolProcessorRegionGrow::init(), vlVolProcessorErode::init(), vlVolProcessorDilate::init(), VolumeCrop::init(), vlVolProcessorConcatenate::init(), vlVolProcessorAlphaAdd::init(), vlVolProcessorRegionGrow::regionGrow(), vlRegionGrowOffsetFinder::regionGrowOffsets(), vlVolProcessorSobel::run(), vlVolProcessorCentralDiff::run(), vlVolProcessorThresh::thresholding(), vlRegionGrowOffsetFinder::vlRegionGrowOffsetFinder(), vlVolInfo::vlVolInfo(), and vlVolume::vlVolume().

void vlVarListAdmin::clear (  bool  all = true  )

If "all" is set to false, only the variables added by admin (this class) are removed, else (the default), all variables are removed. Definition at line 44 of file vlvarlistadmin.cpp. References vlVarList::adminVarList(), vlVarList::adminVarListRW(), and vlVarList::clear(). Referenced by vlVolProcessorDilate::dilate(), vlVolProcessorErode::erode(), vlVolProcessorThresh::init(), vlVolProcessorSobel::init(), vlVolProcessorRegionGrow::init(), vlVolProcessorErode::init(), vlVolProcessorDilate::init(), VolumeCrop::init(), vlVolProcessorConcatenate::init(), vlVolProcessorCentralDiff::init(), vlVolProcessorAlphaAdd::init(), vlVolProcessorRegionGrow::regionGrow(), vlRegionGrowOffsetFinder::regionGrowOffsets(), vlVolInfo::setExtraInfo(), and vlVolInfo::~vlVolInfo().

vlVarListAdmin & vlVarListAdmin::operator= (  const vlVarListAdmin &  other  )

Definition at line 66 of file vlvarlistadmin.cpp. References vlVarList::adminVarList(), and vlVarList::varList().

vlVarListAdmin & vlVarListAdmin::operator= (  const vlVarList &  other  )

Reimplemented from vlVarList. Definition at line 90 of file vlvarlistadmin.cpp. References vlVarList::adminVarList(), and vlVarList::varList().

---

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

• vlvarlistadmin.h
• vlvarlistadmin.cpp

---