Internal Parameter API

The Internal Parameter API. More...

Namespaces
namespace	coreflow
	The internal representation of a vx_array.

Functions
	coreflow::Parameter::Parameter (vx_context context, vx_reference ref)
	Construct a new Parameter object.
	coreflow::Parameter::~Parameter ()
	Destroy the Parameter object.
void	coreflow::Parameter::destruct () override final
	Function to destruct the Parameter object.
static vx_bool	coreflow::Parameter::isValidDirection (vx_enum dir)
	This returns true if the direction is a valid enum.
static vx_bool	coreflow::Parameter::isValidTypeMatch (vx_enum expected, vx_enum supplied)
	This returns true if the supplied type matches the expected type with some fuzzy rules.
static vx_bool	coreflow::Parameter::isValidState (vx_enum state)
	This returns true if the supplied state is a valid enum.
vx_enum	coreflow::Parameter::direction () const
	Returns the direction of the parameter.
vx_uint32	coreflow::Parameter::idx () const
	Returns the index of the parameter.
vx_enum	coreflow::Parameter::dataType () const
	Returns the data type of the parameter.
vx_enum	coreflow::Parameter::state () const
	Returns the state of the parameter.
vx_reference	coreflow::Parameter::ref () const
	Returns the reference referred to by the parameter.
vx_meta_format	coreflow::Parameter::metaFormat () const
	Returns the meta format contained in the parameter.
static vx_parameter	coreflow::Parameter::getKernelParameterByIndex (vx_kernel kernel, vx_uint32 index)
	Get a parameter by index from a kernel.
static vx_parameter	coreflow::Parameter::getParameterByIndex (vx_node node, vx_uint32 index)
	Get a parameter by index from a node.
static vx_status	coreflow::Parameter::setParameterByIndex (vx_node node, vx_uint32 index, vx_reference value)
	Set a parameter by index on a node.
vx_status	coreflow::Parameter::setParameterByReference (vx_reference value)
	Get a parameter by index from a node.

Detailed Description

The Internal Parameter API.

Function Documentation

dataType()

vx_enum coreflow::Parameter::dataType

(

)

const

#include <vx_parameter.h>

Returns the data type of the parameter.

Returns

vx_enum The type of the parameter

destruct()

void coreflow::Parameter::destruct ( )

finaloverridevirtual

#include <vx_parameter.h>

Function to destruct the Parameter object.

Reimplemented from coreflow::Reference.

direction()

vx_enum coreflow::Parameter::direction

(

)

const

#include <vx_parameter.h>

Returns the direction of the parameter.

Returns

vx_enum The direction of the parameter: VX_INPUT, VX_OUTPUT, or VX_BIDIRECTIONAL

getKernelParameterByIndex()

static vx_parameter coreflow::Parameter::getKernelParameterByIndex ( vx_kernel kernel, vx_uint32 index )

static

#include <vx_parameter.h>

Get a parameter by index from a kernel.

Parameters

kernel	The kernel to get the parameter from
index	The index of the parameter

Returns

vx_parameter The parameter object, or nullptr if not found

getParameterByIndex()

static vx_parameter coreflow::Parameter::getParameterByIndex ( vx_node node, vx_uint32 index )

static

#include <vx_parameter.h>

Get a parameter by index from a node.

Parameters

node	The node to get the parameter from
index	The index of the parameter

Returns

vx_parameter The parameter object, or nullptr if not found

idx()

vx_uint32 coreflow::Parameter::idx

(

)

const

#include <vx_parameter.h>

Returns the index of the parameter.

Returns

vx_uint32 The index of the parameter

isValidDirection()

static vx_bool coreflow::Parameter::isValidDirection ( vx_enum dir )

static

#include <vx_parameter.h>

This returns true if the direction is a valid enum.

Parameters

[in]

dir

The vx_direction_e enum.

isValidState()

static vx_bool coreflow::Parameter::isValidState ( vx_enum state )

static

#include <vx_parameter.h>

This returns true if the supplied state is a valid enum.

isValidTypeMatch()

static vx_bool coreflow::Parameter::isValidTypeMatch ( vx_enum expected, vx_enum supplied )

static

#include <vx_parameter.h>

This returns true if the supplied type matches the expected type with some fuzzy rules.

metaFormat()

vx_meta_format coreflow::Parameter::metaFormat

(

)

const

#include <vx_parameter.h>

Returns the meta format contained in the parameter.

Returns

vx_meta_format The meta format contained in the parameter

Parameter()

coreflow::Parameter::Parameter	(	vx_context	context,
		vx_reference	ref )

#include <vx_parameter.h>

Construct a new Parameter object.

Parameters

context
ref

ref()

vx_reference coreflow::Parameter::ref

(

)

const

#include <vx_parameter.h>

Returns the reference referred to by the parameter.

Returns

vx_reference The reference contained in the parameter

setParameterByIndex()

static vx_status coreflow::Parameter::setParameterByIndex ( vx_node node, vx_uint32 index, vx_reference value )

static

#include <vx_parameter.h>

Set a parameter by index on a node.

Parameters

node	The node to set the parameter on
index	The index of the parameter
value	The reference to set as the parameter value

Returns

vx_status VX_SUCCESS on success, error code otherwise

setParameterByReference()

vx_status coreflow::Parameter::setParameterByReference

(

vx_reference

value

)

#include <vx_parameter.h>

Get a parameter by index from a node.

Parameters

value

The reference to set as the parameter value

Returns

vx_status VX_SUCCESS on success, error code otherwise

state()

vx_enum coreflow::Parameter::state

(

)

const

#include <vx_parameter.h>

Returns the state of the parameter.

Returns

vx_enum The state of the parameter: VX_PARAMETER_STATE_REQUIRED or VX_PARAMETER_STATE_OPTIONAL

~Parameter()

coreflow::Parameter::~Parameter

(

)

#include <vx_parameter.h>

Destroy the Parameter object.