#include <vx_reference.h>

Inheritance diagram for coreflow::Reference:

Public Member Functions
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.

virtual void	destruct ()
	Destruct reference.

Static Public Member Functions
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
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.

Protected Member Functions
	Reference (vx_context context, vx_enum type, vx_reference scope)
	Construct a new Reference object.

virtual	~Reference ()
	Destroy the vx reference object.

Member Data Documentation

◆ context

vx_context coreflow::Reference::context

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

◆ delay

vx_delay coreflow::Reference::delay

◆ delay_slot_index

vx_int32 coreflow::Reference::delay_slot_index

◆ external_count

vx_uint32 coreflow::Reference::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.

◆ extracted

vx_bool coreflow::Reference::extracted

This indicates if the object was extracted from another object.

◆ index

vx_uint32 coreflow::Reference::index

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

◆ internal_count

vx_uint32 coreflow::Reference::internal_count

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

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

This indicates if the object is virtual or not.

◆ lock

vx_sem_t coreflow::Reference::lock

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

◆ magic

vx_uint32 coreflow::Reference::magic

Used to validate references, must be set to VX_MAGIC.

◆ name

vx_char coreflow::Reference::name[VX_MAX_REFERENCE_NAME]

The reference name.

◆ platform

struct _vx_platform* coreflow::Reference::platform

Platform for ICD compatibility.

◆ read_count

vx_uint32 coreflow::Reference::read_count

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

◆ reserved

void* coreflow::Reference::reserved

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

◆ scope

vx_reference coreflow::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.

◆ type

vx_enum coreflow::Reference::type

Set to an enum value in vx_type_e.

◆ write_count

vx_uint32 coreflow::Reference::write_count

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

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions