eVision::EPeakVector Class Reference

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

#include <eVision/Easy/EPeakVector.h>

Inheritance diagram for eVision::EPeakVector:

Collaboration diagram for eVision::EPeakVector:

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

EPeakVector() [1/4]

eVision::EPeakVector::EPeakVector

(

)

Constructs a vector.

EPeakVector() [2/4]

eVision::EPeakVector::EPeakVector

(

const eVision::EPeakVector &

other

)

Constructs a vector.

Parameters

other

EPeakVector object to be copied

EPeakVector() [3/4]

eVision::EPeakVector::EPeakVector

(

uint32_t

maxNumberOfElements

)

Constructs a vector.

Parameters

maxNumberOfElements

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

~EPeakVector()

eVision::EPeakVector::~EPeakVector ( ) throw (  )

virtual

EPeakVector() [4/4]

eVision::EPeakVector::EPeakVector

(

CppWrapperInternal::InternalConstructor

)

Member Function Documentation

AddElement()

void eVision::EPeakVector::AddElement

(

eVision::EPeak

element

)

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

Parameters

element

The element to be added.

GetElement()

eVision::EPeak eVision::EPeakVector::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::EPeakVector::GetRawDataPtr

(

)

const

Pointer to the vector data.

operator=()

eVision::EPeakVector & eVision::EPeakVector::operator=

(

const eVision::EPeakVector &

other

)

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

Parameters

other

EPeakVector object to be copied

operator[]()

eVision::EPeak & eVision::EPeakVector::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::EPeakVector::SetElement	(	int32_t	index,
		eVision::EPeak	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.