#include <vx_scalar.h>

Inheritance diagram for coreflow::Scalar:

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

	~Scalar ()
	Destroy the Scalar object.

void *	allocateScalarMemory (vx_size size)
	Allocate memory for scalar obj.

vx_status	copy (void *user_ptr, vx_enum usage, vx_enum user_mem_type)
	Copy scalar value to/from user memory.

vx_status	copy (vx_size size, void *user_ptr, vx_enum usage, vx_enum user_mem_type)
	Copy scalar value, given size, to/from user memory.

vx_status	readValue (void *ptr)
	Read the scalar value.

vx_status	writeValue (const void *ptr)
	Write the scalar value.

vx_enum	dataType () const
	Get the data type of the scalar.

void	destruct () override final
	Function to destroy scalar obj.

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

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_scalar	createScalar (vx_context context, vx_enum data_type, const void *ptr)
	Create a scalar object.

static vx_status	scalarToHostMem (vx_scalar scalar, void *user_ptr)
	Get host memory from scalar obj.

static vx_status	hostMemToScalar (vx_scalar scalar, void *user_ptr)
	Get scalar from host memory.

static void	printScalarValue (vx_scalar scalar)
	Print scalar 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_enum	data_type
	The atomic type of the scalar.

union {

vx_char chr
	A character. More...

vx_int8 s08
	Signed 8 bit. More...

vx_uint8 u08
	Unsigned 8 bit. More...

vx_int16 s16
	Signed 16 bit. More...

vx_uint16 u16
	Unsigned 16 bit. More...

vx_int32 s32
	Signed 32 bit. More...

vx_uint32 u32
	Unsigned 32 bit. More...

vx_int64 s64
	Signed 64 bit. More...

vx_uint64 u64
	Unsigned 64 bit. More...

vx_float32 f32
	32 bit float More...

vx_float64 f64
	64 bit float More...

vx_df_image fcc
	32 bit image format code More...

vx_enum enm
	Signed 32 bit. More...

vx_size size
	Architecture depth unsigned value. More...

vx_bool boolean
	Boolean Values. More...

}	data
	The value contained in the reference for a scalar type.

void *	data_addr
	Only used to scalar with size.

vx_size	data_len
	The length of pointer data_addr.

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

◆ boolean

vx_bool coreflow::Scalar::boolean

Boolean Values.

◆ chr

vx_char coreflow::Scalar::chr

A character.

◆ context

vx_context coreflow::Reference::context

inherited

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

◆ [union]

union { ... } coreflow::Scalar::data

The value contained in the reference for a scalar type.

◆ data_addr

void* coreflow::Scalar::data_addr

Only used to scalar with size.

◆ data_len

vx_size coreflow::Scalar::data_len

The length of pointer data_addr.

◆ data_type

vx_enum coreflow::Scalar::data_type

The atomic type of the scalar.

◆ delay

vx_delay coreflow::Reference::delay

inherited

◆ delay_slot_index

vx_int32 coreflow::Reference::delay_slot_index

inherited

◆ enm

vx_enum coreflow::Scalar::enm

Signed 32 bit.

◆ 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.

◆ f32

vx_float32 coreflow::Scalar::f32

32 bit float

◆ f64

vx_float64 coreflow::Scalar::f64

64 bit float

◆ fcc

vx_df_image coreflow::Scalar::fcc

32 bit image format code

◆ 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.

◆ 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.

◆ s08

vx_int8 coreflow::Scalar::s08

Signed 8 bit.

◆ s16

vx_int16 coreflow::Scalar::s16

Signed 16 bit.

◆ s32

vx_int32 coreflow::Scalar::s32

Signed 32 bit.

◆ s64

vx_int64 coreflow::Scalar::s64

Signed 64 bit.

◆ 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_size coreflow::Scalar::size

Architecture depth unsigned value.

◆ type

vx_enum coreflow::Reference::type

inherited

Set to an enum value in vx_type_e.

◆ u08

vx_uint8 coreflow::Scalar::u08

Unsigned 8 bit.

◆ u16

vx_uint16 coreflow::Scalar::u16

Unsigned 16 bit.

◆ u32

vx_uint32 coreflow::Scalar::u32

Unsigned 32 bit.

◆ u64

vx_uint64 coreflow::Scalar::u64

Unsigned 64 bit.

◆ 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

◆ boolean

◆ chr

◆ context

◆ [union]

◆ data_addr

◆ data_len

◆ data_type

◆ delay

◆ delay_slot_index

◆ enm

◆ external_count

◆ extracted

◆ f32

◆ f64

◆ fcc

◆ index

◆ internal_count

◆ is_accessible

◆ is_virtual

◆ lock

◆ magic

◆ name

◆ platform

◆ read_count

◆ reserved

◆ s08

◆ s16

◆ s32

◆ s64

◆ scope

◆ size

◆ type

◆ u08

◆ u16

◆ u32

◆ u64

◆ write_count