Operator Console
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Public Attributes | List of all members
vecEntry< T > Struct Template Reference

A templated struct that contains all the information for a single vector pass/fail variable. More...

#include <PassFailSettings.h>

Inheritance diagram for vecEntry< T >:
[legend]

Public Member Functions

void assign_value (const std::vector< T > &input, const T &badVal)
 A member function for conditionally assigning the variable 'value' to 'input'. More...
 
 vecEntry (void)
 default constructor More...
 
void assign_value (const std::vector< T > &input, const T &badVal)
 A member function for conditionally assigning the variable 'value' to 'input'. More...
 
 vecEntry (void)
 default constructor More...
 

Public Attributes

CString group_name
 The name to be displayed for the collection. More...
 
CString group_description
 The description for the collection. More...
 
std::vector< CString > sub_names
 Names to be displayed for each element of the variable. More...
 
std::vector< CString > sub_descriptions
 Descriptions to be displayed for each element. More...
 
std::vector< T > value
 A vector containing all the values of the variable. More...
 
std::string data_type
 an indicator for the data_type to be used by inifile() More...
 
bool b_isUsed
 Indicates that this particular variable was found in the pass/fail file and thus should be displayed and kept up to date in the pass/fail file. More...
 

Detailed Description

template<typename T>
struct vecEntry< T >

A templated struct that contains all the information for a single vector pass/fail variable.

Constructor & Destructor Documentation

template<typename T>
vecEntry< T >::vecEntry ( void  )
inline

default constructor

template<typename T>
vecEntry< T >::vecEntry ( void  )
inline

default constructor

Member Function Documentation

template<typename T>
void vecEntry< T >::assign_value ( const std::vector< T > &  input,
const T &  badVal 
)

A member function for conditionally assigning the variable 'value' to 'input'.

if 'input' is != the garbage value returned by inifile() when a variable is not found, then b_isUsed = true and value = input

100 {
101  if (input[0] != badVal)
102  {
103  this->value.resize(input.size());
104  this->b_isUsed = true;
105  for (std::size_t idx=0; idx < input.size(); ++idx;)
106  {
107  this->value[idx] = input[idx];
108  }
109  }
110 }
std::vector< T > value
A vector containing all the values of the variable.
Definition: PassFailSettings.h:90
bool b_isUsed
Indicates that this particular variable was found in the pass/fail file and thus should be displayed ...
Definition: PassFailSettings.h:93
template<typename T>
void vecEntry< T >::assign_value ( const std::vector< T > &  input,
const T &  badVal 
)

A member function for conditionally assigning the variable 'value' to 'input'.

if 'input' is != the garbage value returned by inifile() when a variable is not found, then b_isUsed = true and value = input

Member Data Documentation

template<typename T>
bool vecEntry< T >::b_isUsed

Indicates that this particular variable was found in the pass/fail file and thus should be displayed and kept up to date in the pass/fail file.

Referenced by AddSubVecEntry(), COperatorConsoleApp::ReadPassFail(), and COperatorConsoleApp::WritePassFail().

template<typename T>
std::string vecEntry< T >::data_type

an indicator for the data_type to be used by inifile()

This variable is used by inifile() for determining what data-type should be returned. Set equal to "i" for int, "d" for double, or "" (or "s") for string.

Referenced by CPassFailSettings::CPassFailSettings(), and COperatorConsoleApp::ReadPassFail().

template<typename T>
CString vecEntry< T >::group_description

The description for the collection.

If you want all values to have the same description, you can leave sub_descriptions empty and place the description in group_description

Referenced by AddSubVecEntry(), and CPassFailSettings::CPassFailSettings().

template<typename T>
CString vecEntry< T >::group_name
template<typename T>
std::vector< CString > vecEntry< T >::sub_descriptions

Descriptions to be displayed for each element.

If you want all values to have the same description, you can leave sub_descriptions empty and place the description in group_description

Referenced by AddSubVecEntry().

template<typename T>
std::vector< CString > vecEntry< T >::sub_names

Names to be displayed for each element of the variable.

Referenced by AddSubVecEntry().

template<typename T>
std::vector< T > vecEntry< T >::value

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