oms_wp_phy_measure_entity_get_from_rx_state()
Abstract
Obtains a measurement entity that can be used to write a new value.
Syntax
oms_wp_phy_measure_entity_get_from_rx_state (rx_state_ptr, measure_type, measure_identification_code)
| Argument | Type | Description |
|---|---|---|
rx_state_ptr |
OmsT_WP_Rx_State_Info |
State information for the receiver This receiver state information will be available in a measurement record callback function of type WrlsT_Measurement_Record_Proc_Ptr. For more information, see WrlsT_Measurement_Record_Proc_Ptr. |
measure_type |
OmsT_WP_Measurement_Type |
Measurement type See OmsT_WP_Measurement_Type for more information. |
measure_identification_code |
int |
Code that, combined with the measurement type, uniquely identifies the measurement |
Return Type
OmsT_WP_Measurement_Entity*
Details
This function obtains the measurement entity of the given receiver, which can be used by oms_wp_phy_support_measurement_write() to write new values. Use together with the write function to create the custom measure proc passed to oms_wp_phy_measure_register_single().
Example
Excerpt from coverage_area_tracker process model, header block.
/* Derive the key from the source node obect ID. */
src_node_key = (int) op_topo_parent (op_pk_creation_mod_get (pkptr));
/* Access the entry indicated by the measure key. */
m_entity_ptr = oms_wp_phy_measure_entity_get_from_rx_state (rx_state_ptr, measure_type, src_node_key);