eVision.EPeakVector Class Reference

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

Inheritance diagram for eVision.EPeakVector:

Collaboration diagram for eVision.EPeakVector:

Public Member Functions
None	__init__ (self)
	Constructs a vector.
None	__init__ (self, eVision.EPeakVector other)
	Constructs a vector.
None	__init__ (self, int maxNumberOfElements)
	Constructs a vector.
None	AddElement (self, eVision.EPeak element)
	Appends (adds at the tail) an element to the vector.
eVision.EPeak	GetElement (self, int index)
	Returns the vector element at the given index.
None	SetElement (self, int index, eVision.EPeak value)
	Modifies the vector element at the given index by the given value.
eVision.EPeak	IndexOperator_Getter (self, int index)
None	IndexOperator_Setter (self, int index, eVision.EPeak value)
ctypes.c_void_p	RawDataPtr (self)
	Pointer to the vector data.
Public Member Functions inherited from eVision.EVector
None	Empty (self)
	Resets the number of elements to 0.
None	RemoveElement (self, int index)
	Removes the element at the specified position.
None	Save (self, str path)
	Saves the eVision.EVector object with all its attributes.
None	Save (self, eVision.ESerializer|None serializer)
	Saves the eVision.EVector object with all its attributes.
None	Save (self, str path, int un32Version)
	Saves the eVision.EVector object with all its attributes.
None	Save (self, eVision.ESerializer|None serializer, int un32Version)
	Saves the eVision.EVector object with all its attributes.
None	Load (self, str path)
	Loads the eVision.EVector object with all its attributes.
None	Load (self, eVision.ESerializer|None serializer)
	Loads the eVision.EVector object with all its attributes.
None	Load (self, str path, int un32Version)
	Loads the eVision.EVector object with all its attributes.
None	Load (self, eVision.ESerializer|None serializer, int un32Version)
	Loads the eVision.EVector object with all its attributes.
int	NumElements (self)
	Number of elements in the vector.
	NumElements (self, int value)
	Number of elements in the vector.

Detailed Description

Vector objects are used to store 1-dimensional data.

Remarks:

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 eVision.EVector.Empty member, and then add elements one at time at the tail by calling the eVision.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 eVision.EVector.NumElements.

License(s): BasicTypes

Constructor & Destructor Documentation

__init__() [1/3]

None eVision.EPeakVector.__init__

(

self

)

Constructs a vector.

__init__() [2/3]

None eVision.EPeakVector.__init__	(		self,
		eVision.EPeakVector	other )

Constructs a vector.

Parameters

other

eVision.EPeakVector object to be copied

__init__() [3/3]

None eVision.EPeakVector.__init__	(		self,
		int	maxNumberOfElements )

Constructs a vector.

Parameters

maxNumberOfElements

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

Member Function Documentation

AddElement()

None eVision.EPeakVector.AddElement	(		self,
		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	(		self,
		int	index )

Returns the vector element at the given index.

Remarks:

If the given index is outside the bounds of the vector, the error code eVision.EError.Parameter1OutOfRange is set.

Parameters

index

Index, between 0 and eVision.EVector.NumElements (excluded) of the element to be accessed.

IndexOperator_Getter()

eVision.EPeak eVision.EPeakVector.IndexOperator_Getter	(		self,
		int	index )

IndexOperator_Setter()

None eVision.EPeakVector.IndexOperator_Setter	(		self,
		int	index,
		eVision.EPeak	value )

RawDataPtr()

ctypes.c_void_p eVision.EPeakVector.RawDataPtr

(

self

)

Pointer to the vector data.

SetElement()

None eVision.EPeakVector.SetElement	(		self,
		int	index,
		eVision.EPeak	value )

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

Remarks:

If the given index is outside the bounds of the vector, the error code eVision.EError.Parameter1OutOfRange is set.

Parameters

index	Index, between 0 and eVision.EVector.NumElements (excluded), of the element to be modified.
value	The new value for the element.