Public Types | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
datatypes::EvalCase Class Reference

#include <EvalCase.hpp>

Inheritance diagram for datatypes::EvalCase:
Inheritance graph
[legend]

Public Types

enum  EvaluationStrategy {
  BLANKING = 0, PIXEL = 1, CONTOUR = 2, IO_MAPPING = 3,
  FOCALPOSITION = 4
}
 
enum  FilterType { UNFILTERED = 0 }
 kind of filter which is connected to evaluation case More...
 
enum  InputState { INPUT_INACTIVE = 0, INPUT_LOW_ACTIVE = 1, INPUT_HIGH_ACTIVE = 2 }
 
enum  ManipulationPrevention { ECS_INACTIVE = 0, ECS_ACTIVE = 1 }
 Manipulation prevention. If active, shadowing of field parts may trigger an event. More...
 

Public Member Functions

 EvalCase ()
 
double getBlankingSize () const
 
const std::string & getCaseName () const
 
UINT8 getCaseNumber () const
 
const std::string & getComment () const
 
bool getDistDependent ()
 
UINT16 getFieldNumber () const
 
FilterType getFilterType () const
 
const UINT8 getLogicalInputState_as_UINT8 () const
 
ManipulationPrevention getManipulationPrevention () const
 
double getMaxRadialCorridor () const
 
double getMinFieldExp () const
 
UINT8 getOutputNumber () const
 
UINT32 getResponseTime () const
 
UINT32 getResponseTimeExtended () const
 
bool getResultNegation ()
 
EvaluationStrategy getStrategy () const
 
virtual const UINT32 getUsedMemory () const
 
UINT16 getVersionNumber ()
 
UINT32 getVersionNumberIntern () const
 
bool isDistDependent () const
 
bool isResultNegation () const
 
void setBlankingSize (double blankingSize)
 
void setCaseName (const std::string &caseName)
 
void setCaseNumber (UINT8 caseNumber)
 
void setComment (const std::string &comment)
 
void setDistDependent (bool distDependent)
 
void setFieldNumber (UINT16 fieldNumber)
 
void setFilterType (FilterType filterType)
 
void setLogicalInputState_from_UINT8 (UINT8 value)
 
void setManipulationPrevention (ManipulationPrevention manPrev)
 
void setMaxRadialCorridor (double maxRadialCorridor)
 
void setMinFieldExp (double minFieldExp)
 
void setOutputNumber (UINT8 outputNumber)
 
void setResponseTime (UINT32 responseTime)
 
void setResponseTimeExtended (UINT32 responseTimeExtended)
 
void setResultNegation (bool resultNegation)
 
void setStrategy (EvaluationStrategy strategy)
 
void setVersionNumber (UINT16 versionNumber)
 
virtual ~EvalCase ()
 
- Public Member Functions inherited from datatypes::BasicData
 BasicData ()
 
UINT16 getDatatype ()
 
UINT16 getSourceId ()
 
virtual void setSourceId (UINT16 id)
 
virtual ~BasicData ()
 

Static Public Member Functions

static std::string strategyToString (EvaluationStrategy strategy)
 

Private Attributes

double m_blankingSize
 [m]; minimum object size More...
 
std::string m_caseName
 name of evaluation case is optional More...
 
UINT8 m_caseNumber
 
std::string m_comment
 comment is optional More...
 
bool m_distDependent
 if TRUE field evaluation works distance dependent More...
 
UINT16 m_fieldNumber
 index of field which is connected to evaluation case More...
 
FilterType m_filterType
 
InputState m_logicalInputState [2]
 
ManipulationPrevention m_manipulationPrevention
 
double m_maxRadialCorridor
 [m]; max radial corridor (only active if distance dependency is active) More...
 
double m_minFieldExp
 [m]; minimum radial distance between field start and end point More...
 
UINT16 m_outputNumber
 output which belongs to this evaluation case More...
 
UINT32 m_responseTime
 [µs] More...
 
UINT32 m_responseTimeExtended
 [µs] More...
 
bool m_resultNegation
 negation of evaluation result More...
 
EvaluationStrategy m_strategy
 
UINT16 m_versionNumberIntern
 

Additional Inherited Members

- Protected Attributes inherited from datatypes::BasicData
UINT16 m_datatype
 
UINT16 m_sourceId
 

Detailed Description

Definition at line 20 of file EvalCase.hpp.

Member Enumeration Documentation

enum datatypes::EvalCase::EvaluationStrategy
Enumerator
BLANKING 
PIXEL 
CONTOUR 
IO_MAPPING 
FOCALPOSITION 

Definition at line 23 of file EvalCase.hpp.

enum datatypes::EvalCase::FilterType

kind of filter which is connected to evaluation case

Enumerator
UNFILTERED 

Definition at line 65 of file EvalCase.hpp.

enum datatypes::EvalCase::InputState
Enumerator
INPUT_INACTIVE 

input is not relevant for this evaluation case

INPUT_LOW_ACTIVE 
INPUT_HIGH_ACTIVE 

Definition at line 50 of file EvalCase.hpp.

enum datatypes::EvalCase::ManipulationPrevention

Manipulation prevention. If active, shadowing of field parts may trigger an event.

Enumerator
ECS_INACTIVE 
ECS_ACTIVE 

Definition at line 58 of file EvalCase.hpp.

Constructor & Destructor Documentation

datatypes::EvalCase::EvalCase ( )

Definition at line 16 of file EvalCase.cpp.

datatypes::EvalCase::~EvalCase ( )
virtual

Definition at line 23 of file EvalCase.cpp.

Member Function Documentation

double datatypes::EvalCase::getBlankingSize ( ) const

Definition at line 36 of file EvalCase.cpp.

const std::string & datatypes::EvalCase::getCaseName ( ) const

Definition at line 41 of file EvalCase.cpp.

UINT8 datatypes::EvalCase::getCaseNumber ( ) const

Definition at line 46 of file EvalCase.cpp.

const std::string & datatypes::EvalCase::getComment ( ) const

Definition at line 51 of file EvalCase.cpp.

bool datatypes::EvalCase::getDistDependent ( )

Definition at line 165 of file EvalCase.cpp.

UINT16 datatypes::EvalCase::getFieldNumber ( ) const

Definition at line 56 of file EvalCase.cpp.

EvalCase::FilterType datatypes::EvalCase::getFilterType ( ) const

Definition at line 61 of file EvalCase.cpp.

const UINT8 datatypes::EvalCase::getLogicalInputState_as_UINT8 ( ) const

Definition at line 71 of file EvalCase.cpp.

EvalCase::ManipulationPrevention datatypes::EvalCase::getManipulationPrevention ( ) const

Definition at line 246 of file EvalCase.cpp.

double datatypes::EvalCase::getMaxRadialCorridor ( ) const

Definition at line 77 of file EvalCase.cpp.

double datatypes::EvalCase::getMinFieldExp ( ) const

Definition at line 82 of file EvalCase.cpp.

UINT8 datatypes::EvalCase::getOutputNumber ( ) const

Definition at line 87 of file EvalCase.cpp.

UINT32 datatypes::EvalCase::getResponseTime ( ) const

Definition at line 92 of file EvalCase.cpp.

UINT32 datatypes::EvalCase::getResponseTimeExtended ( ) const

Definition at line 97 of file EvalCase.cpp.

bool datatypes::EvalCase::getResultNegation ( )

Definition at line 220 of file EvalCase.cpp.

EvalCase::EvaluationStrategy datatypes::EvalCase::getStrategy ( ) const

Definition at line 102 of file EvalCase.cpp.

const UINT32 datatypes::EvalCase::getUsedMemory ( ) const
virtual

Implements datatypes::BasicData.

Definition at line 28 of file EvalCase.cpp.

UINT16 datatypes::EvalCase::getVersionNumber ( )

Definition at line 241 of file EvalCase.cpp.

UINT32 datatypes::EvalCase::getVersionNumberIntern ( ) const

Definition at line 107 of file EvalCase.cpp.

bool datatypes::EvalCase::isDistDependent ( ) const

Definition at line 112 of file EvalCase.cpp.

bool datatypes::EvalCase::isResultNegation ( ) const

Definition at line 117 of file EvalCase.cpp.

void datatypes::EvalCase::setBlankingSize ( double  blankingSize)

Definition at line 122 of file EvalCase.cpp.

void datatypes::EvalCase::setCaseName ( const std::string &  caseName)

Definition at line 133 of file EvalCase.cpp.

void datatypes::EvalCase::setCaseNumber ( UINT8  caseNumber)

Definition at line 142 of file EvalCase.cpp.

void datatypes::EvalCase::setComment ( const std::string &  comment)

Definition at line 151 of file EvalCase.cpp.

void datatypes::EvalCase::setDistDependent ( bool  distDependent)

Definition at line 160 of file EvalCase.cpp.

void datatypes::EvalCase::setFieldNumber ( UINT16  fieldNumber)

Definition at line 170 of file EvalCase.cpp.

void datatypes::EvalCase::setFilterType ( FilterType  filterType)

Definition at line 175 of file EvalCase.cpp.

void datatypes::EvalCase::setLogicalInputState_from_UINT8 ( UINT8  value)

Definition at line 260 of file EvalCase.cpp.

void datatypes::EvalCase::setManipulationPrevention ( EvalCase::ManipulationPrevention  manPrev)

Definition at line 251 of file EvalCase.cpp.

void datatypes::EvalCase::setMaxRadialCorridor ( double  maxRadialCorridor)

Definition at line 190 of file EvalCase.cpp.

void datatypes::EvalCase::setMinFieldExp ( double  minFieldExp)

Definition at line 195 of file EvalCase.cpp.

void datatypes::EvalCase::setOutputNumber ( UINT8  outputNumber)

Definition at line 200 of file EvalCase.cpp.

void datatypes::EvalCase::setResponseTime ( UINT32  responseTime)

Definition at line 205 of file EvalCase.cpp.

void datatypes::EvalCase::setResponseTimeExtended ( UINT32  responseTimeExtended)

Definition at line 210 of file EvalCase.cpp.

void datatypes::EvalCase::setResultNegation ( bool  resultNegation)

Definition at line 215 of file EvalCase.cpp.

void datatypes::EvalCase::setStrategy ( EvaluationStrategy  strategy)

Definition at line 225 of file EvalCase.cpp.

void datatypes::EvalCase::setVersionNumber ( UINT16  versionNumber)

Definition at line 233 of file EvalCase.cpp.

static std::string datatypes::EvalCase::strategyToString ( EvaluationStrategy  strategy)
inlinestatic

Definition at line 32 of file EvalCase.hpp.

Member Data Documentation

double datatypes::EvalCase::m_blankingSize
private

[m]; minimum object size

Definition at line 134 of file EvalCase.hpp.

std::string datatypes::EvalCase::m_caseName
private

name of evaluation case is optional

Definition at line 138 of file EvalCase.hpp.

UINT8 datatypes::EvalCase::m_caseNumber
private

Definition at line 123 of file EvalCase.hpp.

std::string datatypes::EvalCase::m_comment
private

comment is optional

Definition at line 139 of file EvalCase.hpp.

bool datatypes::EvalCase::m_distDependent
private

if TRUE field evaluation works distance dependent

Definition at line 131 of file EvalCase.hpp.

UINT16 datatypes::EvalCase::m_fieldNumber
private

index of field which is connected to evaluation case

Definition at line 136 of file EvalCase.hpp.

FilterType datatypes::EvalCase::m_filterType
private

Definition at line 137 of file EvalCase.hpp.

InputState datatypes::EvalCase::m_logicalInputState[2]
private

Definition at line 121 of file EvalCase.hpp.

ManipulationPrevention datatypes::EvalCase::m_manipulationPrevention
private

Definition at line 133 of file EvalCase.hpp.

double datatypes::EvalCase::m_maxRadialCorridor
private

[m]; max radial corridor (only active if distance dependency is active)

Definition at line 132 of file EvalCase.hpp.

double datatypes::EvalCase::m_minFieldExp
private

[m]; minimum radial distance between field start and end point

Definition at line 135 of file EvalCase.hpp.

UINT16 datatypes::EvalCase::m_outputNumber
private

output which belongs to this evaluation case

Definition at line 128 of file EvalCase.hpp.

UINT32 datatypes::EvalCase::m_responseTime
private

[µs]

Definition at line 126 of file EvalCase.hpp.

UINT32 datatypes::EvalCase::m_responseTimeExtended
private

[µs]

Definition at line 127 of file EvalCase.hpp.

bool datatypes::EvalCase::m_resultNegation
private

negation of evaluation result

Definition at line 125 of file EvalCase.hpp.

EvaluationStrategy datatypes::EvalCase::m_strategy
private

Definition at line 124 of file EvalCase.hpp.

UINT16 datatypes::EvalCase::m_versionNumberIntern
private

Definition at line 122 of file EvalCase.hpp.

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

libsick_ldmrs
Author(s): SICK AG , Martin Günther , Jochen Sprickerhof
autogenerated on Mon Oct 26 2020 03:27:30