eVision C++ API 26.10.0-beta.2.dev
Loading...
Searching...
No Matches
eVision::EBW16Vector Class Reference

Vector objects are used to store 1-dimensional data. More...

#include <eVision/Easy/EBW16Vector.h>

Inheritance diagram for eVision::EBW16Vector:
Collaboration diagram for eVision::EBW16Vector:

Public Member Functions

 EBW16Vector ()
 Constructs a vector.
 EBW16Vector (uint32_t maxNumberOfElements)
 Constructs a vector.
 EBW16Vector (const eVision::EBW16Vector &other)
 Constructs a vector.
virtual ~EBW16Vector () throw ()
eVision::EBW16 & operator[] (uint32_t index) const
 Gives access to the vector element at the given index.
eVision::EBW16Vector & operator= (const eVision::EBW16Vector &other)
 Copies all the data from another EBW16Vector object into the current EBW16Vector object.
void * GetRawDataPtr () const
 Pointer to the vector data.
void AddElement (eVision::EBW16 element)
 Appends (adds at the tail) an element to the vector.
eVision::EBW16 GetElement (int32_t index) const
 Returns the vector element at the given index.
void SetElement (int32_t index, eVision::EBW16 value)
 Modifies the vector element at the given index by the given value.
void SetYRange (int32_t n32YMin, uint32_t un32YMax)
void SetYRange (int32_t n32YMin)
void SetYRange ()
void Draw (eVision::EDrawAdapter *graphicContext, float width, float height, float originX, float originY) const
 Draws a plot of the vector element values.
void Draw (eVision::EDrawAdapter *graphicContext, float width, float height, float originX) const
 Draws a plot of the vector element values.
void Draw (eVision::EDrawAdapter *graphicContext, float width, float height) const
 Draws a plot of the vector element values.
void Draw (HDC graphicContext, float width, float height, float originX, float originY) const
 Draws a plot of the vector element values.
void Draw (HDC graphicContext, float width, float height, float originX) const
 Draws a plot of the vector element values.
void Draw (HDC graphicContext, float width, float height) const
 Draws a plot of the vector element values.
void Draw (HDC graphicContext, const eVision::ERGBColor &color, float width, float height, float originX, float originY) const
 Draws a plot of the vector element values.
void Draw (HDC graphicContext, const eVision::ERGBColor &color, float width, float height, float originX) const
 Draws a plot of the vector element values.
void Draw (HDC graphicContext, const eVision::ERGBColor &color, float width, float height) const
 Draws a plot of the vector element values.
void DrawWithCurrentPen (HDC graphicContext, float width, float height, float originX, float originY) const
 Draws a plot of the vector element values.
void DrawWithCurrentPen (HDC graphicContext, float width, float height, float originX) const
 Draws a plot of the vector element values.
void DrawWithCurrentPen (HDC graphicContext, float width, float height) const
 Draws a plot of the vector element values.
float WeightedMoment (uint32_t from, uint32_t to)
 Returns the first order geometric moment (weighted gravity center).
float WeightedMoment (uint32_t from)
 Returns the first order geometric moment (weighted gravity center).
float WeightedMoment ()
 Returns the first order geometric moment (weighted gravity center).
 EBW16Vector (CppWrapperInternal::InternalConstructor)
Public Member Functions inherited from eVision::EVector
virtual ~EVector () throw ()
uint32_t GetNumElements () const
 Number of elements in the vector.
void SetNumElements (uint32_t un32NumElements)
 Number of elements in the vector.
void Empty ()
 Resets the number of elements to 0.
virtual void RemoveElement (uint32_t index)
 Removes the element at the specified position.
void Save (const std::string &path)
 Saves the EVector object with all its attributes.
void Save (eVision::ESerializer *serializer)
 Saves the EVector object with all its attributes.
void Save (const std::string &path, uint32_t un32Version)
 Saves the EVector object with all its attributes.
void Save (eVision::ESerializer *serializer, uint32_t un32Version)
 Saves the EVector object with all its attributes.
void Load (const std::string &path)
 Loads the EVector object with all its attributes.
void Load (eVision::ESerializer *serializer)
 Loads the EVector object with all its attributes.
void Load (const std::string &path, uint32_t un32Version)
 Loads the EVector object with all its attributes.
void Load (eVision::ESerializer *serializer, uint32_t un32Version)
 Loads the EVector object with all its attributes.
 EVector (CppWrapperInternal::InternalConstructor)

Additional Inherited Members

Public Attributes inherited from eVision::EVector
CppWrapperInternal::WrappedClass wrappedClass_

Detailed Description

Vector objects are used to store 1-dimensional data.

Using vectors is very similar to using 1-dimensional arrays, except that the size can vary at runtime. Memory allocation is handled internally.

  • To create a vector, use its constructor.
  • To fill a vector with values, first empty it, using the EVector::Empty member, and then add elements one at time at the tail by calling the EBW16Vector::AddElement member.
  • To access a vector element, either for reading or writing, use the [] operator.
  • To inquire for the current number of elements, use member EVector::GetNumElements.

License(s): BasicTypes

Constructor & Destructor Documentation

◆ EBW16Vector() [1/4]

eVision::EBW16Vector::EBW16Vector ( )

Constructs a vector.

◆ EBW16Vector() [2/4]

eVision::EBW16Vector::EBW16Vector ( uint32_t maxNumberOfElements)

Constructs a vector.

Parameters
maxNumberOfElementsOptionally, memory can be pre-allocated to accommodate a given number of elements.

◆ EBW16Vector() [3/4]

eVision::EBW16Vector::EBW16Vector ( const eVision::EBW16Vector & other)

Constructs a vector.

Parameters
otherEBW16Vector object to be copied

◆ ~EBW16Vector()

eVision::EBW16Vector::~EBW16Vector ( )
throw ( )
virtual

◆ EBW16Vector() [4/4]

eVision::EBW16Vector::EBW16Vector ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ AddElement()

void eVision::EBW16Vector::AddElement ( eVision::EBW16 element)

Appends (adds at the tail) an element to the vector.

Parameters
elementThe element to be added.

◆ Draw() [1/9]

void eVision::EBW16Vector::Draw ( eVision::EDrawAdapter * graphicContext,
float width,
float height ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

◆ Draw() [2/9]

void eVision::EBW16Vector::Draw ( eVision::EDrawAdapter * graphicContext,
float width,
float height,
float originX ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.
originXAbscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

◆ Draw() [3/9]

void eVision::EBW16Vector::Draw ( eVision::EDrawAdapter * graphicContext,
float width,
float height,
float originX,
float originY ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.
originXAbscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.
originYOrdinate of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

◆ Draw() [4/9]

void eVision::EBW16Vector::Draw ( HDC graphicContext,
const eVision::ERGBColor & color,
float width,
float height ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [5/9]

void eVision::EBW16Vector::Draw ( HDC graphicContext,
const eVision::ERGBColor & color,
float width,
float height,
float originX ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.
originXAbscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [6/9]

void eVision::EBW16Vector::Draw ( HDC graphicContext,
const eVision::ERGBColor & color,
float width,
float height,
float originX,
float originY ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
colorThe color in which to draw the overlay.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.
originXAbscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.
originYOrdinate of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [7/9]

void eVision::EBW16Vector::Draw ( HDC graphicContext,
float width,
float height ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [8/9]

void eVision::EBW16Vector::Draw ( HDC graphicContext,
float width,
float height,
float originX ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.
originXAbscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ Draw() [9/9]

void eVision::EBW16Vector::Draw ( HDC graphicContext,
float width,
float height,
float originX,
float originY ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.
originXAbscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.
originYOrdinate of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawWithCurrentPen() [1/3]

void eVision::EBW16Vector::DrawWithCurrentPen ( HDC graphicContext,
float width,
float height ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawWithCurrentPen() [2/3]

void eVision::EBW16Vector::DrawWithCurrentPen ( HDC graphicContext,
float width,
float height,
float originX ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.
originXAbscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ DrawWithCurrentPen() [3/3]

void eVision::EBW16Vector::DrawWithCurrentPen ( HDC graphicContext,
float width,
float height,
float originX,
float originY ) const

Draws a plot of the vector element values.

Parameters
graphicContextHandle of the device context on which to draw.
widthOutermost horizontal size, in pixels.
heightOutermost vertical size, in pixels.
originXAbscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.
originYOrdinate of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.

A vector is able to draw itself in a window. The vector plots the element values as a function of the element indices. The drawing appears on a neutral background. Drawing is done in the device context associated to the desired window. To draw the curves, the current pen is used. To draw the annotations, a black pen is used instead.

Deprecated
Deprecated in version 23.12. Scheduled to be removed in version 27.6.

◆ GetElement()

eVision::EBW16 eVision::EBW16Vector::GetElement ( int32_t index) const

Returns the vector element at the given index.

Parameters
indexIndex, between 0 and EVector::GetNumElements (excluded) of the element to be accessed.

If the given index is outside the bounds of the vector, the error code EError::EError_Parameter1OutOfRange is set.

◆ GetRawDataPtr()

void * eVision::EBW16Vector::GetRawDataPtr ( ) const

Pointer to the vector data.

◆ operator=()

eVision::EBW16Vector & eVision::EBW16Vector::operator= ( const eVision::EBW16Vector & other)

Copies all the data from another EBW16Vector object into the current EBW16Vector object.

Parameters
otherEBW16Vector object to be copied

◆ operator[]()

eVision::EBW16 & eVision::EBW16Vector::operator[] ( uint32_t index) const

Gives access to the vector element at the given index.

Parameters
indexIndex, between 0 and EVector::GetNumElements (excluded) of the element to be accessed.

◆ SetElement()

void eVision::EBW16Vector::SetElement ( int32_t index,
eVision::EBW16 value )

Modifies the vector element at the given index by the given value.

Parameters
indexIndex, between 0 and EVector::GetNumElements (excluded), of the element to be modified.
valueThe new value for the element.

If the given index is outside the bounds of the vector, the error code EError::EError_Parameter1OutOfRange is set.

◆ SetYRange() [1/3]

void eVision::EBW16Vector::SetYRange ( )

◆ SetYRange() [2/3]

void eVision::EBW16Vector::SetYRange ( int32_t n32YMin)

◆ SetYRange() [3/3]

void eVision::EBW16Vector::SetYRange ( int32_t n32YMin,
uint32_t un32YMax )

◆ WeightedMoment() [1/3]

float eVision::EBW16Vector::WeightedMoment ( )

Returns the first order geometric moment (weighted gravity center).

◆ WeightedMoment() [2/3]

float eVision::EBW16Vector::WeightedMoment ( uint32_t from)

Returns the first order geometric moment (weighted gravity center).

Parameters
fromFirst element of the vector portion for which the weighted moment will be calculated. By default, this is the first element of the vector.

◆ WeightedMoment() [3/3]

float eVision::EBW16Vector::WeightedMoment ( uint32_t from,
uint32_t to )

Returns the first order geometric moment (weighted gravity center).

Parameters
fromFirst element of the vector portion for which the weighted moment will be calculated. By default, this is the first element of the vector.
toLast element of the vector portion for which the weighted moment will be calculated. By default, this is the last element of the vector.