FloatArrayTool Class Reference

#include <FloatArrayTool.h>

Inheritance diagram for FloatArrayTool:

Public Types
using	Index = unsigned int
using	FloatVector = std::vector< float >

Public Member Functions
virtual	~FloatArrayTool ()=default
virtual Index	offset () const
virtual std::string	label () const
virtual std::string	unit () const
virtual const FloatVector &	values () const =0
virtual Index	size () const
virtual float	defaultValue () const
virtual bool	inRange (Index ival) const
virtual float	value (Index ival) const
virtual float	value (Index ival, float defval) const
virtual int	fill (FloatVector &vals, float valdef) const

Detailed Description

Definition at line 15 of file FloatArrayTool.h.

Member Typedef Documentation

using FloatArrayTool::FloatVector = std::vector<float>

Definition at line 20 of file FloatArrayTool.h.

using FloatArrayTool::Index = unsigned int

Definition at line 19 of file FloatArrayTool.h.

Constructor & Destructor Documentation

virtual FloatArrayTool::~FloatArrayTool ( )

virtualdefault

Member Function Documentation

virtual float FloatArrayTool::defaultValue ( ) const

inlinevirtual

Reimplemented in FclFloatArray, and FclFileFloatArray.

Definition at line 41 of file FloatArrayTool.h.

{ return 0.0; }

virtual int FloatArrayTool::fill ( FloatVector &  vals, float  valdef  ) const

inlinevirtual

Definition at line 66 of file FloatArrayTool.h.

                                                          {
    Index len = offset() + size();
    if ( len > vals.size() ) vals.resize(len, valdef);
    std::copy(values().begin(), values().end(), vals.begin() + offset());
    return 0;
  }

virtual bool FloatArrayTool::inRange ( Index  ival ) const

inlinevirtual

Definition at line 44 of file FloatArrayTool.h.

                                         {
    if ( ival < offset() ) return false;
    if ( ival + offset() >= size() ) return false;
    return true;
  }

virtual std::string FloatArrayTool::label ( ) const

inlinevirtual

Reimplemented in FclFloatArray.

Definition at line 28 of file FloatArrayTool.h.

{ return ""; }

virtual Index FloatArrayTool::offset ( ) const

inlinevirtual

Reimplemented in FclFloatArray.

Definition at line 25 of file FloatArrayTool.h.

{ return 0; }

virtual Index FloatArrayTool::size ( ) const

inlinevirtual

Reimplemented in FclFileFloatArray.

Definition at line 37 of file FloatArrayTool.h.

{ return values().size(); }

virtual std::string FloatArrayTool::unit ( ) const

inlinevirtual

Reimplemented in FclFileFloatArray, and FclFloatArray.

Definition at line 31 of file FloatArrayTool.h.

{ return ""; }

virtual float FloatArrayTool::value ( Index  ival ) const

inlinevirtual

Definition at line 51 of file FloatArrayTool.h.

                                        {
    if ( ! inRange(ival) ) return defaultValue();
    return values()[ival + offset()];
  }

virtual float FloatArrayTool::value ( Index  ival, float  defval  ) const

inlinevirtual

Definition at line 55 of file FloatArrayTool.h.

                                                      {
    if ( ! inRange(ival) ) return defval;
    return values()[ival + offset()];
  }

virtual const FloatVector& FloatArrayTool::values ( ) const

pure virtual

Implemented in FclFloatArray, and FclFileFloatArray.

---

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

• dunecore/dunecore/DuneInterface/Tool/FloatArrayTool.h