pcolsetvalue

Sets numerical value to collection.

Synopsis

pcolsetvalue name type value [col_in|-] [col_out|-]

Description

pcolsetvalue adds the specified value value of type type to the input collection col_in with the specified name. The result collection is saved into col_out.

If the item named name already exist, the value is replaced by the new value value.

Parameters

name is the name of the numerical value in the input collection. It is a string without blank character.
type is a string that defines the numerical type among [Char, Uchar, Short, Ushort, Long, Ulong, Float, Double].
value is a numerical value which type depends on the input image type.

Inputs

col_in: a collection.

Outputs

col_out: a collection.

Result

Returns SUCCESS or FAILURE.

Examples

Adds the float value 10.5 in the collection col.pan with the name "foo" and verifies if the value is in the collection:

  pobject2col image tangram.pan col.pan
  pcolsetvalue foo Float 10.5 col.pan col.pan
  pfile col.pan 
  pcolgetvalue foo col.pan 
  pstatus

C++ prototype

Errc PColSetValue( Collection &col_in_out, const std::string& name, const std::string& type, float value );

Version française

Ajout de la valeur d'un élément numérique dans une collection.

Author: Régis Clouard