| main | class hierarchy | alphabetical | list | functions | files | tutorial | programs |

smtk::validation Class Reference

a base class to add validation More...

Inheritance diagram for smtk::validation:

[legend]List of all members.

Public Member Functions
bool	is_invalid (void) const
	see if the object is invalid
bool	is_valid (void) const
	see if the object is valid
	validation (bool is_vld=false)
virtual	~validation (void)
Protected Member Functions
template<class T>
T	invalidate (T t)
	invalidate the object
void	invalidate (void)
	invalidate the object
template<class T>
T	validate (T t)
	validate the object
void	validate (void)
	validate the object

---

Detailed Description

a base class to add validation

This is a base class to add methods to test if a super class is usable (valid) or not.

---

Constructor & Destructor Documentation

smtk::validation::validation

(

bool

is_vld = false

)

[inline]

Parameters:

is_vld

If is_vld is true the constructed object will be validated when it is constructed, if is_vld is false the constructed object will be invalid when it is constructed.

smtk::validation::~validation

(

void

)

[virtual]

The destructor will make the object invalid.

---

Member Function Documentation

template<class T>

T smtk::validation::invalidate

(

T

t

)

[inline, protected]

invalidate the object

Make the object invalid.

Returns:

t the argument the user passed.

void smtk::validation::invalidate

(

void

)

[inline, protected]

invalidate the object

Make the object invalid.

bool smtk::validation::is_invalid

(

void

)

const [inline]

see if the object is invalid

Returns:

true if the object is invalid, and false if not.

bool smtk::validation::is_valid

(

void

)

const [inline]

see if the object is valid

Returns:

true if the object is valid, and false if not.

template<class T>

T smtk::validation::validate

(

T

t

)

[inline, protected]

validate the object

Make the object valid.

Returns:

t the argument the user passed.

void smtk::validation::validate

(

void

)

[inline, protected]

validate the object

Make the object valid.

---

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

• libsmtk/smtk/validation.h
• libsmtk/validation.cpp

---