Description

TR-069 Device.MoCA.Interface.AssociatedDevice object Getter API

This is the getter group of API for the Device.MoCA.Interface.{i}.AssociatedDevice.{j} object.

The interface for all functions is identical and is described here.

Parameters

[in]	*name	This is the complete path name of the parameter extracted from soap message, e.g. ::get_Device_MoCA_Interface_AssociatedDevice_MACAddress. In this case, the path is "Device.MoCA.Interface.{i}.AssociatedDevice.{j}.MACAddress".
[in]	*type	Data type of parameter defined for TR-069. This is same as the data type used in the Xi3 data-model.xml file. (see parameter.h)
[out]	*value	This is the value of the parameter requested by the ACS. (see paramaccess.h)

Returns: The status of the operation.

Return values

OK	If parameter requested was successfully fetched. (Same as NO_ERROR).
NO_ERROR	If parameter requested was successfully fetched. (Same as OK).
DIAG_ERROR	Diagnostic error.
ERR_???	Appropriate error value otherwise (see dimark_globals.h).

Data Structures
class	MoCAInterfaceAssociatedDevice

Data Structure Documentation

◆ MoCAInterfaceAssociatedDevice

class MoCAInterfaceAssociatedDevice

Definition at line 98 of file Device_MoCA_Interface_AssociatedDevice.h.

Collaboration diagram for MoCAInterfaceAssociatedDevice:

Public Member Functions

int	get_MACAddress (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the MAC address of the associated device's MoCA interface. More...

int	get_NodeID (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the Node ID of this remote device. More...

int	get_PreferredNC (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Check whether the MoCA remote device is a preferred Network Coordinator (NC). More...

int	get_HighestVersion (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the identifies the highest MoCA version that this remote device supports. More...

int	get_PHYTxRate (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the PHY transmit rate (in Mbps) to this remote device. More...

int	get_PHYRxRate (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the PHY receive rate (in Mbps) from this remote device. More...

int	get_TxPowerControlReduction (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the reduction in transmitter level (in dB) due to power control. More...

int	get_RxPowerLevel (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the power level (in dBm) received at the MoCA interface from this remote device. More...

int	get_TxBcastRate (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the broadcast PHY transmit rate (in Mbps) from this remote device. More...

int	get_RxBcastPowerLevel (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the power level (in dBm) received at the MoCA interface from this remote device. More...

int	get_TxPackets (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the number of packets transmitted to this remote device (Note: Includes Broadcast, Multicast and Unicast packets). More...

int	get_RxPackets (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the number of packets received from this remote device (Note: Includes Broadcast, Multicast and Unicast packets). More...

int	get_RxErroredAndMissedPackets (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the number of errored and missed packets received from this remote device. More...

int	get_QAM256Capable (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Check whether this remote device supports the 256 QAM feature. More...

int	get_PacketAggregationCapability (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the packet aggregation capability supported by the remote device. Standard values are 0 (no support), 6 (6 packets) or 10 (10 packets). More...

int	get_RxSNR (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Get the signal to noise level (in dBm) received at this interface from this remote device. More...

int	get_Active (HOSTIF_MsgData_t stMsgData, unsigned int associatedDeviceNum, bool pChanged=NULL)
	Check whether or not this remote device is currently present in the MoCA network. More...

Static Public Member Functions
static class MoCAInterfaceAssociatedDevice *	getInstance ()

static void	closeInstance ()

Private Member Functions
	MoCAInterfaceAssociatedDevice (int dev_id)

Private Attributes
int	dev_id

char	m_i8MacAddress [24]

unsigned int	m_ui32NodeId

bool	m_bPreferredNC

char	m_i8HighestVersion [64]

unsigned int	m_ui32PhyTxRate

unsigned int	m_ui32PhyRxRate

unsigned int	m_ui32TxPowerControlReduction

int	m_i32RxPowerLevel

unsigned int	m_ui32TxBcastRate

int	m_i32RxBcastPowerLevel

unsigned int	m_ui32TxPackets

unsigned int	m_ui32RxPackets

unsigned int	m_ui32RxErroredAndMissedPackets

bool	m_bQAM256Capable

unsigned int	m_ui32PacketAggregationCapability

unsigned int	m_ui32RxSNR

bool	m_bActive

Static Private Attributes
static class MoCAInterfaceAssociatedDevice *	Instance = NULL

Description

TR-069 Device.MoCA.Interface.AssociatedDevice object Getter API

Data Structures

Data Structure Documentation

◆ MoCAInterfaceAssociatedDevice

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes