coreflow::UserDataObject Class Reference

#include <vx_user_data_object.h>

Inheritance diagram for coreflow::UserDataObject:

Public Member Functions
	UserDataObject (vx_context context, vx_reference scope)
	Construct a new User Data Object object.
	~UserDataObject ()
	Destroy the User Data Object object.
const vx_char *	typeName () const
	Get the type name of the user data object.
vx_size	objSize () const
	Get the size of the user data object.
vx_bool	allocateUserDataObject ()
	Allocate user data object.
vx_status	copy (vx_size offset, vx_size size, void *user_ptr, vx_enum usage, vx_enum user_mem_type)
	Copy data to/from user memory.
vx_status	map (vx_size offset, vx_size size, vx_map_id *map_id, void **ptr, vx_enum usage, vx_enum mem_type, vx_uint32 flags)
	Map the user data object for access.
vx_status	unmap (vx_map_id map_id)
	Unmap the user data object from access.
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_user_data_object	createUserDataObject (vx_context context, const vx_char *type_name, vx_size size, const void *ptr)
	Create a user data 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
	Memory layout.
vx_uint32	size
	size of buffer in bytes
vx_char	type_name [VX_MAX_REFERENCE_NAME]
	The type name of the user data object.
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

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.

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::UserDataObject::memory

Memory layout.

name

vx_char coreflow::Reference::name[VX_MAX_REFERENCE_NAME]

inherited

The reference name.

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.

size

vx_uint32 coreflow::UserDataObject::size

size of buffer in bytes

type

vx_enum coreflow::Reference::type

inherited

Set to an enum value in vx_type_e.

type_name

vx_char coreflow::UserDataObject::type_name[VX_MAX_REFERENCE_NAME]

The type name of the user data object.

write_count

vx_uint32 coreflow::Reference::write_count

inherited

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