Internal Delay API

The Internal Delay API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Classes
struct	vx_delay_param_t
	The internal representation of the delay parameters as a list. More...

Functions
	coreflow::Delay::Delay (vx_context context, vx_reference scope)
	Construct a new Delay object.
	coreflow::Delay::~Delay ()
	Destroy the Delay object.
static vx_delay	coreflow::Delay::createDelay (vx_context context, vx_reference exemplar, vx_size count)
	Create a delay object.
vx_enum	coreflow::Delay::dataType () const
	Get data type of references associated with this delay object.
vx_size	coreflow::Delay::numObjects () const
	Get the number of objects in this delay object.
vx_reference	coreflow::Delay::getReference (vx_int32 index)
	Retrieves a reference to a delay slot object.
static vx_bool	coreflow::Delay::removeAssociationToDelay (vx_reference value, vx_node n, vx_uint32 i)
	Removes an association to a node from a delay slot object reference.
static vx_bool	coreflow::Delay::addAssociationToDelay (vx_reference value, vx_node n, vx_uint32 i)
	Adds an association to a node to a delay slot object reference.
vx_status	coreflow::Delay::age ()
	Shifts the internal delay ring by one.
void	coreflow::Delay::destruct () override final
	Destruct function for delay objects.

Detailed Description

The Internal Delay API.

Function Documentation

addAssociationToDelay()

static vx_bool coreflow::Delay::addAssociationToDelay ( vx_reference value, vx_node n, vx_uint32 i )

static

#include <vx_delay.h>

Adds an association to a node to a delay slot object reference.

Parameters

[in]	value	The delay slot object reference.
[in]	n	The node reference.
[in]	i	The index of the parameter.

age()

vx_status coreflow::Delay::age

(

)

#include <vx_delay.h>

Shifts the internal delay ring by one.

This function performs a shift of the internal delay ring by one. This means that, the data originally at index 0 move to index -1 and so forth until index \( -count+1 \). The data originally at index \( -count+1 \) move to index 0. Here \( count \) is the number of slots in delay ring. When a delay is aged, any graph making use of this delay (delay object itself or data objects in delay slots) gets its data automatically updated accordingly.

Returns

vx_status VX_SUCCESS if successful, any other value indicates failure.

createDelay()

static vx_delay coreflow::Delay::createDelay ( vx_context context, vx_reference exemplar, vx_size count )

static

#include <vx_delay.h>

Create a delay object.

Parameters

context
exemplar
count

Returns

vx_delay

dataType()

vx_enum coreflow::Delay::dataType

(

)

const

#include <vx_delay.h>

Get data type of references associated with this delay object.

Returns

vx_enum The data type of references.

Delay()

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

#include <vx_delay.h>

Construct a new Delay object.

Parameters

context
scope

destruct()

void coreflow::Delay::destruct ( )

finaloverridevirtual

#include <vx_delay.h>

Destruct function for delay objects.

Reimplemented from coreflow::Reference.

getReference()

vx_reference coreflow::Delay::getReference

(

vx_int32

index

)

#include <vx_delay.h>

Retrieves a reference to a delay slot object.

Parameters

[in]

index

The index of the delay slot from which to extract the object reference.

Returns

vx_reference The vx_reference at the index specified if found, otherwise an error object

numObjects()

vx_size coreflow::Delay::numObjects

(

)

const

#include <vx_delay.h>

Get the number of objects in this delay object.

Returns

vx_size The number of objects in this delay object

removeAssociationToDelay()

static vx_bool coreflow::Delay::removeAssociationToDelay ( vx_reference value, vx_node n, vx_uint32 i )

static

#include <vx_delay.h>

Removes an association to a node from a delay slot object reference.

Parameters

[in]	value	The delay slot object reference.
[in]	n	The node reference.
[in]	i	The index of the parameter.

~Delay()

coreflow::Delay::~Delay

(

)

#include <vx_delay.h>

Destroy the Delay object.