#include <vx_array.h>

Inheritance diagram for coreflow::Array:

Public Member Functions
	Array (vx_context context, vx_reference scope)
	Construct a new Array object.

	Array (vx_context context, vx_enum type, vx_reference scope)
	Construct a new Array object.

	~Array ()
	Destroy the Array object.

vx_bool	validateArray (vx_enum item_type, vx_size capacity)
	Validate array object.

vx_bool	allocateArray ()
	Allocate memory for array object.

void	initArrayMemory ()
	Initialize internal array memory.

vx_bool	initVirtualArray (vx_enum item_type, vx_size capacity)
	Initialize virutal array object.

vx_status	addItems (vx_size count, const void *ptr, vx_size stride)
	Add items to array.

vx_status	truncate (vx_size new_num_items)
	Truncate array to new number of items.

vx_enum	itemType () const
	Get item type of the array.

vx_size	numItems () const
	Get number of items in array.

vx_size	totalCapacity () const
	Get capacity of array.

vx_size	itemSize () const
	Get item size in array.

vx_size	totalSize () const
	Get total size of array.

vx_uint32	offsetVal () const
	Get offset value.

vx_status	accessArrayRange (vx_size start, vx_size end, vx_size pStride, void *ptr, vx_enum usage)
	Access array range in object.

vx_status	commitArrayRange (vx_size start, vx_size end, const void *ptr)
	Commit array range.

vx_status	copyArrayRange (vx_size start, vx_size end, vx_size stride, void *ptr, vx_enum usage, vx_enum mem_type)
	Copy array range.

vx_status	mapArrayRange (vx_size start, vx_size end, vx_map_id map_id, vx_size stride, void **ptr, vx_enum usage, vx_enum mem_type, vx_uint32 flags)
	Map array range.

vx_status	unmapArrayRange (vx_map_id map_id)
	Unmap array range.

void	destruct () override final
	Destruct function for array object.

vx_uint32	refCount () const
	Returns the reference count of the object.

vx_enum	dataType () const
	Returns the type of the reference.

const vx_char *	refName () const
	Returns the name of the reference.

void	setName (const vx_char *name)
	Sets the name of the reference.

vx_uint32	incrementReference (vx_reftype_e refType)
	Increments the ref count.

vx_uint32	decrementReference (vx_reftype_e refType)
	Decrements the ref count.

vx_uint32	totalReferenceCount ()
	Returns the total reference count of the object.

void	initReferenceForDelay (vx_delay delay, vx_int32 index)
	Used to initialize any vx_reference as a delay element.

Static Public Member Functions
static vx_array	createArray (vx_context context, vx_enum item_type, vx_size capacity, vx_bool is_virtual=vx_false_e, vx_enum type=VX_TYPE_ARRAY)
	Create a Array object.

static vx_lut_t	createLUT (vx_context context, vx_enum data_type, vx_size count)
	Create a LUT object.

static vx_size	itemSize (vx_context context, vx_enum item_type)
	Get item size of type.

static vx_bool	isValidArrayItemType (vx_context context, vx_enum item_type)
	Validate array item type.

static vx_bool	isValidArray (vx_array arr)
	Validate array object.

static void	printArray (vx_array array)
	Print array object.

static vx_reference	createReference (vx_context context, vx_enum type, vx_reftype_e refType, vx_reference scope)
	Used to create a reference.

static void	printReference (vx_reference ref)
	Prints the values of a reference.

static vx_bool	isValidReference (vx_reference ref)
	Used to validate everything but vx_context, vx_image and vx_buffer.

static vx_bool	isValidReference (vx_reference ref, vx_enum type)
	Used to validate everything but vx_context, vx_image and vx_buffer.

static vx_size	sizeOfType (vx_enum type)
	Returns the number of bytes in the internal structure for a given type.

static vx_status	releaseReference (vx_reference *ref, vx_enum type, vx_reftype_e reftype, vx_destructor_f special_destructor)
	Used to destroy a reference.

Public Attributes
vx_memory_t	memory
	The memory layout definition.

vx_enum	item_type
	The item type of the array.

vx_size	item_size
	The size of array item in bytes.

vx_size	num_items
	The number of items in the array.

vx_size	capacity
	The array capacity.

vx_uint32	offset
	Offset attribute value. Used internally by LUT implementation.

struct _vx_platform *	platform
	Platform for ICD compatibility.

vx_uint32	magic
	Used to validate references, must be set to VX_MAGIC.

vx_enum	type
	Set to an enum value in vx_type_e.

vx_context	context
	Pointer to the top level context. If this reference is the context, this will be NULL.

vx_reference	scope
	The pointer to the object's scope parent. When virtual objects are scoped within a graph, this will point to that parent graph. This is left generic to allow future scoping variations. By default scope should be the same as context.

vx_uint32	external_count
	The count of the number of users with this reference. When greater than 0, this can not be freed. When zero, the value can be considered inaccessible.

vx_uint32	internal_count
	The count of the number of framework references. When greater than 0, this can not be freed.

vx_uint32	read_count
	The number of times the object has been read (in some portion)

vx_uint32	write_count
	The number of times the object has been written to (in some portion)

vx_sem_t	lock
	The reference lock which is used to protect access to "in-fly" data.

void *	reserved
	A reserved field which can be used to store anonymous data.

vx_uint32	index
	A field which can be used to store a temporary, per-graph index.

vx_bool	extracted
	This indicates if the object was extracted from another object.

vx_bool	is_virtual
	This indicates if the object is virtual or not.

vx_delay	delay

vx_int32	delay_slot_index

vx_bool	is_accessible
	This indicates that if the object is virtual whether it is accessible at the moment or not.

vx_char	name [VX_MAX_REFERENCE_NAME]
	The reference name.

Member Data Documentation

◆ capacity

vx_size coreflow::Array::capacity

The array capacity.

◆ context

vx_context coreflow::Reference::context

inherited

Pointer to the top level context. If this reference is the context, this will be NULL.

◆ delay

vx_delay coreflow::Reference::delay

inherited

◆ delay_slot_index

vx_int32 coreflow::Reference::delay_slot_index

inherited

◆ external_count

vx_uint32 coreflow::Reference::external_count

inherited

The count of the number of users with this reference. When greater than 0, this can not be freed. When zero, the value can be considered inaccessible.

◆ extracted

vx_bool coreflow::Reference::extracted

inherited

This indicates if the object was extracted from another object.

◆ index

vx_uint32 coreflow::Reference::index

inherited

A field which can be used to store a temporary, per-graph index.

◆ internal_count

vx_uint32 coreflow::Reference::internal_count

inherited

The count of the number of framework references. When greater than 0, this can not be freed.

◆ is_accessible

vx_bool coreflow::Reference::is_accessible

inherited

This indicates that if the object is virtual whether it is accessible at the moment or not.

◆ is_virtual

vx_bool coreflow::Reference::is_virtual

inherited

This indicates if the object is virtual or not.

◆ item_size

vx_size coreflow::Array::item_size

The size of array item in bytes.

◆ item_type

vx_enum coreflow::Array::item_type

The item type of the array.

◆ lock

vx_sem_t coreflow::Reference::lock

inherited

The reference lock which is used to protect access to "in-fly" data.

◆ magic

vx_uint32 coreflow::Reference::magic

inherited

Used to validate references, must be set to VX_MAGIC.

◆ memory

vx_memory_t coreflow::Array::memory

The memory layout definition.

◆ name

vx_char coreflow::Reference::name[VX_MAX_REFERENCE_NAME]

inherited

The reference name.

◆ num_items

vx_size coreflow::Array::num_items

The number of items in the array.

◆ offset

vx_uint32 coreflow::Array::offset

Offset attribute value. Used internally by LUT implementation.

◆ platform

struct _vx_platform* coreflow::Reference::platform

inherited

Platform for ICD compatibility.

◆ read_count

vx_uint32 coreflow::Reference::read_count

inherited

The number of times the object has been read (in some portion)

◆ reserved

void* coreflow::Reference::reserved

inherited

A reserved field which can be used to store anonymous data.

◆ scope

vx_reference coreflow::Reference::scope

inherited

The pointer to the object's scope parent. When virtual objects are scoped within a graph, this will point to that parent graph. This is left generic to allow future scoping variations. By default scope should be the same as context.

◆ type

vx_enum coreflow::Reference::type

inherited

Set to an enum value in vx_type_e.

◆ write_count

vx_uint32 coreflow::Reference::write_count

inherited

The number of times the object has been written to (in some portion)

Public Member Functions

Static Public Member Functions

Public Attributes

Member Data Documentation

◆ capacity

◆ context

◆ delay

◆ delay_slot_index

◆ external_count

◆ extracted

◆ index

◆ internal_count

◆ is_accessible

◆ is_virtual

◆ item_size

◆ item_type

◆ lock

◆ magic

◆ memory

◆ name

◆ num_items

◆ offset

◆ platform

◆ read_count

◆ reserved

◆ scope

◆ type

◆ write_count