oms_wp_phy_module_attr_get()

Abstract

Gets specified properties of the PHY module.

Syntax

oms_wp_phy_module_attr_get (phy_handle, attr_id_0, attr_0_ptr, attr_id_1, attr_1_ptr, attr_id_n, attr_n_ptr, end_of_arguments_id);

Argument Type Description
phy_handle OmsT_WP_Phy_Handle* Handle of the PHY module
attr_id_<num> int Use the predefined attribute ID constants given in Table 10.
See the table at the end of this function description for the complete list of attribute ID constants and their descriptions.
attr_<num>_ptr Variable pointer type Pointer to a variable to be filled in with the specified attribute’s value. The pointer type must match the requirement of the corresponding attribute ID.
end_of_arguments_id int Always use OMSC_WP_ARG_END

Return Type

Compcode

Returns OPC_COMPCODE_SUCCESS, if the properties were retrieved properly. Otherwise, returns OPC_COMPCODE_FAILURE.

Details

This function is used to retrieve the values of some PHY module specific attributes by the client module (for example, the MAC module).

Note: To retrieve attributes from the PHY module, the client process model must call oms_wp_phy_module_initialize_single_carrier() or oms_wp_phy_module_initialize_multi_carrier() first, and then call this function in an event later than the event when that initialization call is made.

The number of arguments this function receives is variable. The first argument is the PHY module handle, which must always be present. The next arguments are the properties to be retrieved from the PHY module. Each property is set by a pair of consecutive arguments. The first argument of each pair is the constant that represents the property to be retrieved, followed by a pointer to a memory location where the value of such a property must be set. After all property arguments are specified, the last argument must be the special constant OMSC_WP_ARG_END that terminates the list of arguments passed to this function.

When calling this function, it is mandatory to specify the PHY module handle, at least one property (with the corresponding pair of arguments), and OMSC_WP_ARG_END in the end.

Table 10: Values for attr_id_<num> Argument

Symbolic Constants Corresponding Value Type Description
OMSC_WP_ATTR_PHY_MIMO_TX_ANT_COUNT int* Pointer to memory location to store number of MIMO transmitter antennas.
OMSC_WP_ATTR_PHY_MIMO_RX_ANT_COUNT int* Pointer to memory location to store number of MIMO receive antennas.
OMSC_WP_ATTR_PHY_MIMO_TX_TECHNIQUE OmsT_WP_MIMO_Tx_Technique* Pointer to memory location to store MIMO transmission technique. The MIMO transmission technique can be transmit diversity or spatial multiplexing.
See OmsT_WP_MIMO_Tx_Technique for more information.

Example

Excerpt from lte_enb_as process model, function block .

/* Get the PHY attributes.						*/
if (oms_wp_phy_module_attr_get (phy_module_hdl,
	OMSC_WP_ATTR_PHY_MIMO_TX_ANT_COUNT, &tx_ant_count,
	OMSC_WP_ATTR_PHY_MIMO_RX_ANT_COUNT, &rx_ant_count,
	OMSC_WP_ATTR_PHY_MIMO_TX_TECHNIQUE, &wp_mimo_tx_tech,
	OMSC_WP_ATTR_ARG_END) == OPC_COMPCODE_FAILURE)
	{
	op_sim_end ("Unable to get the PHY information.", OPC_NIL, OPC_NIL);
	}

本站文档由 北京智网畅联科技有限公司 整理、翻译并提供 · Documentation compiled and provided by Beijing ZNetLink Technology Co., Ltd.

交流群 · QQ Group:OPNET/智网妙算网络仿真交流群(群号 486383494)

原文档 © 2017 Riverbed Technology · 本站为公益翻译,由 AI 辅助完成,请仔细甄别

Original documentation © 2017 Riverbed Technology. Community translation, AI-assisted. Contact: jiazequn@znetlink.com