Ovis_Decoration_Info_Group_Scalar_Element_Value_Set()
Abstract
Specifies the scalar element of the Ovis group.
Syntax
Ovis_Decoration_Info_Group_Scalar_Element_Value_Set (group_ptr, element_name, value)
| Argument | Type | Description |
|---|---|---|
group_ptr |
OvisT_Info_Group * |
Decoration |
element_name |
const char * |
Element name |
value |
double |
Scalar value |
Return Type
OvisT_Compcode
OvisC_Compcode_Success if the value could be assigned; OvisC_Compcode_Failure otherwise.
Header
ovis_decoration.h
Details
This function specifies the scalar element of the Ovis group. Use Ovis_Decoration_Info_Template_Range_Element_Add() and Ovis_Decoration_Info_Template_Scalar_Element_Add() to create those elements.
Example
#define INCOMING_PACKET_FIELD "Incoming"
OvisT_Info_Template * template;
OvisT_Info_Group * info;
OvisT_3D_Position pos;
template = Ovis_Decoration_Info_Template_Create ("Packet count");
Ovis_Decoration_Info_Template_Scalar_Element_Add (template, INCOMING_PACKET_FIELD);
Ovis_Position_Geodetic_Set (&pos, 0, 0, 100);
info = Ovis_Decoration_Info_Group_Create (template, pos,
prg_color_from_string ("blue"), OPC_NIL, OPC_NIL, OPC_NIL);
Ovis_Decoration_Info_Group_Scalar_Element_Value_Set (info,
INCOMING_PACKET_FIELD, 10);
Errors
- Decoration is NIL.
- No element name provided.
- Element "<name>" is not part of the info group.
Reference
- Use the functions
Ovis_Decoration_Info_Template_Scalar_Element_Add()orOvis_Decoration_Info_Template_Range_Element_Add()to set up a scalar component of a template.