eVision::EListItem Struct Reference

Describes list items. This class pertains to the EasyObject legacy API. Please use ECodedImage2 for all new developments instead. More...

#include <eVision/Easy/EListItem.h>

Public Member Functions
	EListItem ()
	Default constructor.

Public Attributes
void *	PPrev
	Previous list item.
int8_t *	Pn8Data
	Data pointer.
void *	PNext
	Next element.

Detailed Description

Describes list items. This class pertains to the EasyObject legacy API. Please use ECodedImage2 for all new developments instead.

A list is a sequence of orderly list items. Each list item contains a pointer to a memory zone containing its data, a pointer to the previous list item, and a pointer to the next list item.

List items. A few ECodedImage methods handle EListItem objects, or EListItem pointers.

Runs lists: ECodedImage::GetFirstRunData, ECodedImage::GetFirstRunPtr, ECodedImage::GetLastRunData, ECodedImage::GetLastRunPtr, ECodedImage::GetPreviousRunData, ECodedImage::GetPreviousRunPtr, ECodedImage::GetNextRunData, ECodedImage::GetNextRunPtr These properties and methods allow to traverse the runs lists from the first run to the last, or from one run to its previous or next neighbor. A run can also be directly reached by its index within the list. The first run has index 0. The last run has index NumRuns-1. The ECodedImage::GetRunData and ECodedImage::GetRunDataPtr methods return the run data, or a pointer to the run data.

Objects lists: ECodedImage::GetFirstObjData, ECodedImage::GetLastObjData, ECodedImage::GetPreviousObjData, ECodedImage::GetPreviousObjPtr, ECodedImage::GetNextObjData, ECodedImage::GetNextObjPtr These properties and methods allow to traverse the objects lists from the first object to the last, or from one object to its previous or next neighbor. An object can also be directly reached by its index within the list. The first object has index 0. The last object has index NumObjects-1. The ECodedImage::GetObjectData and ECodedImage::GetObjDataPtr methods return the object data, or a pointer to the object data.

License(s): None

Deprecated

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

Constructor & Destructor Documentation

EListItem()

eVision::EListItem::EListItem

(

)

Default constructor.

Member Data Documentation

Pn8Data

int8_t* eVision::EListItem::Pn8Data

Data pointer.

PNext

void* eVision::EListItem::PNext

Next element.

PPrev

void* eVision::EListItem::PPrev

Previous list item.