Internal Object Array API

The Internal Object Array API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
	coreflow::ObjectArray::ObjectArray (vx_context context, vx_reference scope)
	Construct a new Object Array object.
	coreflow::ObjectArray::~ObjectArray ()
	Destroy the Object Array object.
static vx_object_array	coreflow::ObjectArray::createObjectArray (vx_context context, vx_enum type)
	Create a Object Array object.
static vx_object_array	coreflow::ObjectArray::createObjectArray (vx_reference scope, vx_reference exemplar, vx_size count, vx_bool is_virtual=vx_false_e)
	Create a Object Array object.
vx_status	coreflow::ObjectArray::initObjectArray (vx_reference exemplar, vx_size num_items)
	Initialize object array.
static vx_bool	coreflow::ObjectArray::isValidObjectArray (vx_object_array arr)
	Validate object array.
static vx_bool	coreflow::ObjectArray::isValidObjectArray (vx_object_array objarr, vx_enum item_type, vx_size num_items)
	Validate object array.
vx_reference	coreflow::ObjectArray::getItem (vx_size index) const
	Get the item at the specified index.
vx_status	coreflow::ObjectArray::setItem (vx_size index, vx_reference ref)
	Set the item at the specified index.
vx_enum	coreflow::ObjectArray::itemType () const
	Get the item type of the object array.
vx_size	coreflow::ObjectArray::numItems () const
	Get the number of items in the object array.
void	coreflow::ObjectArray::destruct () override final
	Function to destroy the object array.

Detailed Description

The Internal Object Array API.

Function Documentation

createObjectArray() [1/2]

static vx_object_array coreflow::ObjectArray::createObjectArray ( vx_context context, vx_enum type )

static

#include <vx_object_array.h>

Create a Object Array object.

Parameters

context	The context associated with this obj
type	The type of the object array

Returns

vx_object_array The object array object

createObjectArray() [2/2]

static vx_object_array coreflow::ObjectArray::createObjectArray ( vx_reference scope, vx_reference exemplar, vx_size count, vx_bool is_virtual = vx_false_e )

static

#include <vx_object_array.h>

Create a Object Array object.

Parameters

scope	Parent ref of obj
exemplar	ref to create arry of
count	depth of obj arr
is_virtual	indicate if obj should be virtual

Returns

vx_object_array Object array created

destruct()

void coreflow::ObjectArray::destruct ( )

finaloverridevirtual

#include <vx_object_array.h>

Function to destroy the object array.

Reimplemented from coreflow::Reference.

getItem()

vx_reference coreflow::ObjectArray::getItem

(

vx_size

index

)

const

#include <vx_object_array.h>

Get the item at the specified index.

Parameters

index

The index of the item to get

Returns

vx_reference The reference to the item

initObjectArray()

vx_status coreflow::ObjectArray::initObjectArray	(	vx_reference	exemplar,
		vx_size	num_items )

#include <vx_object_array.h>

Initialize object array.

Parameters

exemplar	Ref of object array
num_items	num of items in array

Returns

vx_status VX_SUCCESS if successful

isValidObjectArray() [1/2]

static vx_bool coreflow::ObjectArray::isValidObjectArray ( vx_object_array arr )

static

#include <vx_object_array.h>

Validate object array.

Parameters

arr	Ref of object array

Returns

vx_bool vx_true_e if valid | otherwise vx_false_e

isValidObjectArray() [2/2]

static vx_bool coreflow::ObjectArray::isValidObjectArray ( vx_object_array objarr, vx_enum item_type, vx_size num_items )

static

#include <vx_object_array.h>

Validate object array.

Parameters

objarr	Ref of object array
item_type	type of data in array
num_items	num of items in array

Returns

vx_bool vx_true_e if valid | otherwise vx_false_e

itemType()

vx_enum coreflow::ObjectArray::itemType

(

)

const

#include <vx_object_array.h>

Get the item type of the object array.

Returns

vx_enum The item type of the object array

numItems()

vx_size coreflow::ObjectArray::numItems

(

)

const

#include <vx_object_array.h>

Get the number of items in the object array.

Returns

vx_size The number of items in the object array

ObjectArray()

coreflow::ObjectArray::ObjectArray	(	vx_context	context,
		vx_reference	scope )

#include <vx_object_array.h>

Construct a new Object Array object.

Parameters

context	The context associated with this obj
scope	The parent ref of this obj

setItem()

vx_status coreflow::ObjectArray::setItem	(	vx_size	index,
		vx_reference	ref )

#include <vx_object_array.h>

Set the item at the specified index.

Parameters

index	The index of the item to set
ref	The reference to set at the index

Returns

vx_status VX_SUCCESS on success, error code otherwise

~ObjectArray()

coreflow::ObjectArray::~ObjectArray

(

)

#include <vx_object_array.h>

Destroy the Object Array object.