Public Member Functions | Private Attributes
gevd_param_mixin Class Reference

#include <gevd_param_mixin.h>

Inheritance diagram for gevd_param_mixin:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 gevd_param_mixin ()
 Constructor. By default a constructed parameter block is valid.
virtual ~gevd_param_mixin ()
virtual bool SanityCheck ()
 Check if parameters are valid. The default does nothing.
bool Valid () const
const char * GetErrorMsg () const
void SetErrorMsg (const char *msg)
 Set the error message for this parameter block.

Private Attributes

bool valid_
vcl_string error_msg_

Detailed Description

Definition at line 37 of file gevd_param_mixin.h.


Constructor & Destructor Documentation

gevd_param_mixin::gevd_param_mixin ( ) [inline]

Constructor. By default a constructed parameter block is valid.

Definition at line 44 of file gevd_param_mixin.h.

virtual gevd_param_mixin::~gevd_param_mixin ( ) [inline, virtual]

Definition at line 46 of file gevd_param_mixin.h.


Member Function Documentation

const char* gevd_param_mixin::GetErrorMsg ( ) const [inline]

Definition at line 50 of file gevd_param_mixin.h.

bool gevd_param_mixin::SanityCheck ( ) [virtual]

Check if parameters are valid. The default does nothing.

Reimplemented in gevd_detector_params, and gevd_region_proc_params.

Definition at line 41 of file gevd_param_mixin.cxx.

void gevd_param_mixin::SetErrorMsg ( const char *  msg)

Set the error message for this parameter block.

If the message is not empty, this sets the valid flag to be false. An empty message resets the valid flag to be true.

Definition at line 47 of file gevd_param_mixin.cxx.

bool gevd_param_mixin::Valid ( ) const [inline]

Definition at line 49 of file gevd_param_mixin.h.


Member Data Documentation

vcl_string gevd_param_mixin::error_msg_ [private]

Definition at line 40 of file gevd_param_mixin.h.

bool gevd_param_mixin::valid_ [private]

Definition at line 39 of file gevd_param_mixin.h.


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