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

#include <eVision/Easy/EBW8Vector.h>

Inheritance diagram for eVision::EBW8Vector:

Collaboration diagram for eVision::EBW8Vector:

Public Member Functions
	EBW8Vector ()
	Constructs a vector.
	EBW8Vector (uint32_t maxNumberOfElements)
	Constructs a vector.
	EBW8Vector (const eVision::EBW8Vector &other)
	Constructs a vector.
virtual	~EBW8Vector () throw ()
eVision::EBW8 &	operator[] (uint32_t index) const
	Gives access to the vector element at the given index.
eVision::EBW8Vector &	operator= (const eVision::EBW8Vector &other)
	Copies all the data from another EBW8Vector object into the current EBW8Vector object.
void *	GetRawDataPtr () const
	Pointer to the vector data.
void	AddElement (eVision::EBW8 element)
	Appends (adds at the tail) an element to the vector.
eVision::EBW8	GetElement (int32_t index) const
	Returns the vector element at the given index.
void	SetElement (int32_t index, eVision::EBW8 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).
	EBW8Vector (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 EBW8Vector::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

◆ EBW8Vector() [1/4]

eVision::EBW8Vector::EBW8Vector ( )

Constructs a vector.

◆ EBW8Vector() [2/4]

eVision::EBW8Vector::EBW8Vector ( uint32_t maxNumberOfElements )

Constructs a vector.

Parameters

maxNumberOfElements Optionally, memory can be pre-allocated to accommodate a given number of elements.

◆ EBW8Vector() [3/4]

eVision::EBW8Vector::EBW8Vector ( const eVision::EBW8Vector & other )

Constructs a vector.

Parameters

other EBW8Vector object to be copied

◆ ~EBW8Vector()

eVision::EBW8Vector::~EBW8Vector	(		)
throw	(	)

virtual

◆ EBW8Vector() [4/4]

eVision::EBW8Vector::EBW8Vector ( CppWrapperInternal::InternalConstructor )

Member Function Documentation

◆ AddElement()

void eVision::EBW8Vector::AddElement ( eVision::EBW8 element )

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

Parameters

element The element to be added.

◆ Draw() [1/9]

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

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost 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::EBW8Vector::Draw	(	eVision::EDrawAdapter *	graphicContext,
		float	width,
		float	height,
		float	originX ) const

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost vertical size, in pixels.
originX	Abscissa 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::EBW8Vector::Draw	(	eVision::EDrawAdapter *	graphicContext,
		float	width,
		float	height,
		float	originX,
		float	originY ) const

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost vertical size, in pixels.
originX	Abscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.
originY	Ordinate 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::EBW8Vector::Draw	(	HDC	graphicContext,
		const eVision::ERGBColor &	color,
		float	width,
		float	height ) const

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
width	Outermost horizontal size, in pixels.
height	Outermost 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

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [5/9]

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

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
width	Outermost horizontal size, in pixels.
height	Outermost vertical size, in pixels.
originX	Abscissa 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

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [6/9]

void eVision::EBW8Vector::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

graphicContext	Handle of the device context on which to draw.
color	The color in which to draw the overlay.
width	Outermost horizontal size, in pixels.
height	Outermost vertical size, in pixels.
originX	Abscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.
originY	Ordinate 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

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [7/9]

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

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost 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

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [8/9]

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

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost vertical size, in pixels.
originX	Abscissa 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

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ Draw() [9/9]

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

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost vertical size, in pixels.
originX	Abscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.
originY	Ordinate 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

Use the overload taking an EDrawAdapter by using an instance of EWindowsDrawAdapter.

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

◆ DrawWithCurrentPen() [1/3]

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

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost 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::EBW8Vector::DrawWithCurrentPen	(	HDC	graphicContext,
		float	width,
		float	height,
		float	originX ) const

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost vertical size, in pixels.
originX	Abscissa 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::EBW8Vector::DrawWithCurrentPen	(	HDC	graphicContext,
		float	width,
		float	height,
		float	originX,
		float	originY ) const

Draws a plot of the vector element values.

Parameters

graphicContext	Handle of the device context on which to draw.
width	Outermost horizontal size, in pixels.
height	Outermost vertical size, in pixels.
originX	Abscissa of the upper left corner of the plot's bounding rectangle, in pixels. By default, the upper left corner of the window is used.
originY	Ordinate 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::EBW8 eVision::EBW8Vector::GetElement ( int32_t index ) const

Returns the vector element at the given index.

Parameters

index Index, 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::EBW8Vector::GetRawDataPtr ( ) const

Pointer to the vector data.

◆ operator=()

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

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

Parameters

other EBW8Vector object to be copied

◆ operator[]()

eVision::EBW8 & eVision::EBW8Vector::operator[] ( uint32_t index ) const

Gives access to the vector element at the given index.

Parameters

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

◆ SetElement()

void eVision::EBW8Vector::SetElement	(	int32_t	index,
		eVision::EBW8	value )

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

Parameters

index	Index, between 0 and EVector::GetNumElements (excluded), of the element to be modified.
value	The 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::EBW8Vector::SetYRange ( )

◆ SetYRange() [2/3]

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

◆ SetYRange() [3/3]

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

◆ WeightedMoment() [1/3]

float eVision::EBW8Vector::WeightedMoment ( )

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

◆ WeightedMoment() [2/3]

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

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

Parameters

from	First 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::EBW8Vector::WeightedMoment	(	uint32_t	from,
		uint32_t	to )

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

Parameters

from	First element of the vector portion for which the weighted moment will be calculated. By default, this is the first element of the vector.
to	Last element of the vector portion for which the weighted moment will be calculated. By default, this is the last element of the vector.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EBW8Vector() [1/4]

◆ EBW8Vector() [2/4]

◆ EBW8Vector() [3/4]

◆ ~EBW8Vector()

◆ EBW8Vector() [4/4]

Member Function Documentation

◆ AddElement()

◆ Draw() [1/9]

◆ Draw() [2/9]

◆ Draw() [3/9]

◆ Draw() [4/9]

◆ Draw() [5/9]

◆ Draw() [6/9]

◆ Draw() [7/9]

◆ Draw() [8/9]

◆ Draw() [9/9]

◆ DrawWithCurrentPen() [1/3]

◆ DrawWithCurrentPen() [2/3]

◆ DrawWithCurrentPen() [3/3]

◆ GetElement()

◆ GetRawDataPtr()

◆ operator=()

◆ operator[]()

◆ SetElement()

◆ SetYRange() [1/3]

◆ SetYRange() [2/3]

◆ SetYRange() [3/3]

◆ WeightedMoment() [1/3]

◆ WeightedMoment() [2/3]

◆ WeightedMoment() [3/3]