v_sim.NodeValuesFarray¶

Subclasses:: v_sim.NodeValuesCoord, v_sim.NodeValuesPole, v_sim.NodeValuesVector

Methods¶

Inherited:: v_sim.NodeValues (17), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`new` (arr, label, dimension)
class	`new_fromFile` (arr, label, filename)
	`getAt` (node)
	`getAtIter` (iter)
	`getColumnMinMax` (column)
	`getFile` ()
	`getFloatAt` (node, column)
	`getFloatAtIter` (iter, column)
	`max` ()
	`min` ()
	`nrm2` ()
	`scale` (factor)
	`set` (data)
	`setAt` (node, vals)
	`setAtDbl` (node, vals, ln)

Virtual Methods¶

Inherited:: v_sim.NodeValues (4), GObject.Object (7)

do_nrm2 (value)

Properties¶

Inherited:: v_sim.NodeValues (6)

Name	Type	Flags	Short Description
`data-min-max`	`GLib.Array`	r	min / max values of data
`maximum`	`float`	r	maximum norm
`minimum`	`float`	r	minimum norm
`source-file`	`str`	r	Source file if any
`square-norm`	`float`	r	Square norm

Signals¶

Inherited:: v_sim.NodeValues (1), GObject.Object (1)

Fields¶

Inherited:: v_sim.NodeValues (1), GObject.Object (1)

Name	Type	Access	Description
parent	`v_sim.NodeValues`	r
priv	`v_sim.NodeValuesFarrayPrivate`	r

Class Details¶

class v_sim.NodeValuesFarray(**kwargs)¶

Bases:: v_sim.NodeValues
Abstract:: No
Structure:: v_sim.NodeValuesFarrayClass

Common name to refer to a #_VisuNodeValuesFarray.

classmethod new(arr, label, dimension)¶

Parameters:

arr (v_sim.NodeArray) – a v_sim.NodeArray object.
label (str) – a translatable label.
dimension (int) – a integer value.

Returns:

a newly created v_sim.NodeValuesFarray object.

Return type:

v_sim.NodeValuesFarray

Create a new farray field located on nodes, storing dimension floats per node.

New in version 3.8.

classmethod new_fromFile(arr, label, filename)¶

Parameters:

arr (v_sim.NodeArray) – a v_sim.NodeArray object.
label (str) – a label.
filename (str) – a filename.

Raises:

GLib.Error

Returns:

a newly created v_sim.NodeValuesFarray object.

Return type:

v_sim.NodeValuesFarray

Parse filename to read floating point values and creates a new v_sim.NodeValuesFarray object based on arr. If an error occurs, an empty v_sim.NodeValuesFarray object is created.

New in version 3.8.

getAt(node)¶

Parameters:: node (v_sim.Node) – a v_sim.Node object.
Returns:: the coordinates of float array for node.
Return type:: float

Retrieves the float array hosted on node.

New in version 3.8.

getAtIter(iter)¶

Parameters:: iter (v_sim.NodeValuesIter) – an iterator on self.
Returns:: a pointer to the float array.
Return type:: float

Provide the floats stored in self at iter.

New in version 3.8.

getColumnMinMax(column)¶

Parameters:

column (int) – an integer.

Returns:

False if column < 0 or if column is greater than the number of read column or if no file has been set.

minMax:: an allocated array of two floating point values ;

Return type:

(bool, minMax: [float])

This method is used to retrieve the minimum and the maximum values of the column designed by the column argument. Column are numbered beginning at 0.

getFile()¶

Returns:: a filename.
Return type:: str

Retrieve the filename from which the values have been read, if any.

New in version 3.8.

getFloatAt(node, column)¶

Parameters:

node (v_sim.Node) – a v_sim.Node pointer.
column (int) – a column id.

Returns:

a float value.

Return type:

float

Retrieves the float value stored for node at column, if any.

New in version 3.8.

getFloatAtIter(iter, column)¶

Parameters:

iter (v_sim.NodeValuesIter) – a v_sim.NodeValuesIter object.
column (int) – a column id.

Returns:

a float value.

Return type:

float

Retrieves the float value stored for the current iteration of iter for the column column. iter must be running on self.

New in version 3.8.

max()¶

Returns:: the maximum farray norm.
Return type:: float

Computes and returns the longest farray in the field.

New in version 3.8.

min()¶

Returns:: the minimum farray norm.
Return type:: float

Computes and returns the smallest farray in the field.

New in version 3.8.

nrm2()¶

Returns:: the square norm of the farray field.
Return type:: float

Computes and returns the sum of square norm all farrays in the field.

New in version 3.8.

scale(factor)¶

Parameters:: factor (float) – a factor.

Multiply every element of self by factor.

New in version 3.8.

set(data)¶

Parameters:: data ([float]) – some farray coordinates.
Returns:: True if data has the same size as self.
Return type:: bool

Assigns the coordinates stored in data to each nodes in self.

New in version 3.8.

setAt(node, vals)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
vals ([float]) – farray coordinates.

Returns:

True if farray for node is indeed changed.

Return type:

bool

Changes the float array hosted at node for one of values defined by vals.

New in version 3.8.

setAtDbl(node, vals, ln)¶

Parameters:

node (v_sim.Node) – a v_sim.Node object.
vals ([float]) – farray coordinates.
ln (int) – a length.

Returns:

True if farray for node is indeed changed.

Return type:

bool

Same as v_sim.NodeValuesFarray.setAt() but for double values.

New in version 3.8.

do_nrm2(value) virtual¶

Parameters:: value (GObject.Value) – a value.
Return type:: float

the function used to compute the squared norm of the float array.

Property Details¶

v_sim.NodeValuesFarray.props.data_min_max¶

Name:: data-min-max
Type:: GLib.Array
Default Value:: None
Flags:: READABLE

min / max values of data

v_sim.NodeValuesFarray.props.maximum¶

Name:: maximum
Type:: float
Default Value:: 0.0
Flags:: READABLE

maximum norm

v_sim.NodeValuesFarray.props.minimum¶

Name:: minimum
Type:: float
Default Value:: 0.0
Flags:: READABLE

minimum norm

v_sim.NodeValuesFarray.props.source_file¶

Name:: source-file
Type:: str
Default Value:: None
Flags:: READABLE

Source file if any

v_sim.NodeValuesFarray.props.square_norm¶

Name:: square-norm
Type:: float
Default Value:: 0.0
Flags:: READABLE

Square norm