channel_monitor

Documentation

Overview

This model describes operational state data for an optical channel monitor (OCM) for optical transport line system elements such as wavelength routers (ROADMs) and amplifiers.

Index

• type ChannelMonitors
  • func (channelMonitors *ChannelMonitors) GetEntityData() *types.CommonEntityData
• type ChannelMonitors_ChannelMonitor
  • func (channelMonitor *ChannelMonitors_ChannelMonitor) GetEntityData() *types.CommonEntityData
• type ChannelMonitors_ChannelMonitor_Channels
  • func (channels *ChannelMonitors_ChannelMonitor_Channels) GetEntityData() *types.CommonEntityData
• type ChannelMonitors_ChannelMonitor_Channels_Channel
  • func (channel *ChannelMonitors_ChannelMonitor_Channels_Channel) GetEntityData() *types.CommonEntityData
• type ChannelMonitors_ChannelMonitor_Channels_Channel_State
  • func (state *ChannelMonitors_ChannelMonitor_Channels_Channel_State) GetEntityData() *types.CommonEntityData
• type ChannelMonitors_ChannelMonitor_Config
  • func (config *ChannelMonitors_ChannelMonitor_Config) GetEntityData() *types.CommonEntityData
• type ChannelMonitors_ChannelMonitor_State
  • func (state *ChannelMonitors_ChannelMonitor_State) GetEntityData() *types.CommonEntityData

Types

type ChannelMonitors

type ChannelMonitors struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of channel monitors, keyed by channel monitor name. The type is slice
	// of ChannelMonitors_ChannelMonitor.
	ChannelMonitor []*ChannelMonitors_ChannelMonitor
}

ChannelMonitors Top-level container for optical channel monitors

func (*ChannelMonitors) GetEntityData

func (channelMonitors *ChannelMonitors) GetEntityData() *types.CommonEntityData

type ChannelMonitors_ChannelMonitor

type ChannelMonitors_ChannelMonitor struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. References the optical channel monitor name. The
	// type is string. Refers to
	// channel_monitor.ChannelMonitors_ChannelMonitor_Config_Name
	Name interface{}

	// Configuration data .
	Config ChannelMonitors_ChannelMonitor_Config

	// Operational state data .
	State ChannelMonitors_ChannelMonitor_State

	// Enclosing container for the list of values describing the power spectral
	// density distribution.
	Channels ChannelMonitors_ChannelMonitor_Channels
}

ChannelMonitors_ChannelMonitor List of channel monitors, keyed by channel monitor name.

func (*ChannelMonitors_ChannelMonitor) GetEntityData

func (channelMonitor *ChannelMonitors_ChannelMonitor) GetEntityData() *types.CommonEntityData

type ChannelMonitors_ChannelMonitor_Channels

type ChannelMonitors_ChannelMonitor_Channels struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// List of tuples describing the PSD distribution. The type is slice of
	// ChannelMonitors_ChannelMonitor_Channels_Channel.
	Channel []*ChannelMonitors_ChannelMonitor_Channels_Channel
}

ChannelMonitors_ChannelMonitor_Channels Enclosing container for the list of values describing the power spectral density distribution

func (*ChannelMonitors_ChannelMonitor_Channels) GetEntityData

func (channels *ChannelMonitors_ChannelMonitor_Channels) GetEntityData() *types.CommonEntityData

type ChannelMonitors_ChannelMonitor_Channels_Channel

type ChannelMonitors_ChannelMonitor_Channels_Channel struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter
	YListKey   string

	// This attribute is a key. Reference to the list key. The type is string with
	// range: 0..18446744073709551615. Refers to
	// channel_monitor.ChannelMonitors_ChannelMonitor_Channels_Channel_State_LowerFrequency
	LowerFrequency interface{}

	// This attribute is a key. Reference to the list key. The type is string with
	// range: 0..18446744073709551615. Refers to
	// channel_monitor.ChannelMonitors_ChannelMonitor_Channels_Channel_State_UpperFrequency
	UpperFrequency interface{}

	// Operational state data for PSD.
	State ChannelMonitors_ChannelMonitor_Channels_Channel_State
}

ChannelMonitors_ChannelMonitor_Channels_Channel List of tuples describing the PSD distribution

func (*ChannelMonitors_ChannelMonitor_Channels_Channel) GetEntityData

func (channel *ChannelMonitors_ChannelMonitor_Channels_Channel) GetEntityData() *types.CommonEntityData

type ChannelMonitors_ChannelMonitor_Channels_Channel_State

type ChannelMonitors_ChannelMonitor_Channels_Channel_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Lower frequency of the specified PSD. The type is interface{} with range:
	// 0..18446744073709551615.
	LowerFrequency interface{}

	// Upper frequency of the specified PSD. The type is interface{} with range:
	// 0..18446744073709551615.
	UpperFrequency interface{}

	// Power spectral density expressed in nanowatts per megahertz, nW/MHz.  These
	// units allow the value to often be greater than 1.0.  It also avoids dealing
	// with zero values for 0dBm.  For example, a 40GHz wide channel with 0dBm
	// power would be:  0dBm = 1mW = 10^6nW  40GHz = 40,000MHz  0dBm/40GHz =
	// 10^6nW/40,000MHz = 1000/40 = 25. The type is string with length: 32..32.
	// Units are nW/MHz.
	Psd interface{}
}

ChannelMonitors_ChannelMonitor_Channels_Channel_State Operational state data for PSD

func (*ChannelMonitors_ChannelMonitor_Channels_Channel_State) GetEntityData

func (state *ChannelMonitors_ChannelMonitor_Channels_Channel_State) GetEntityData() *types.CommonEntityData

type ChannelMonitors_ChannelMonitor_Config

type ChannelMonitors_ChannelMonitor_Config struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Reference to system-supplied name of the port on the optical channel
	// monitor (OCM). If this port is embedded in another card (i.e. an amplifier
	// card) the device should still define a port representing the OCM even if it
	// is internal and not physically present on the faceplate of the card. The
	// type is string. Refers to platform.Components_Component_Name
	Name interface{}

	// Reference to system-supplied name of the port that the channel monitor is
	// physically connected to. This port will be of type MONITOR. This port is a
	// tap off of the monitored-port and would be in the same card as the
	// monitored port. If this port is embedded in another card (i.e. an amplifier
	// card) the device should still define a port representing the monitor port
	// if it is internal and not physically present on the faceplate of the card.
	// The type is string. Refers to platform.Components_Component_Name
	MonitorPort interface{}
}

ChannelMonitors_ChannelMonitor_Config Configuration data

func (*ChannelMonitors_ChannelMonitor_Config) GetEntityData

func (config *ChannelMonitors_ChannelMonitor_Config) GetEntityData() *types.CommonEntityData

type ChannelMonitors_ChannelMonitor_State

type ChannelMonitors_ChannelMonitor_State struct {
	EntityData types.CommonEntityData
	YFilter    yfilter.YFilter

	// Reference to system-supplied name of the port on the optical channel
	// monitor (OCM). If this port is embedded in another card (i.e. an amplifier
	// card) the device should still define a port representing the OCM even if it
	// is internal and not physically present on the faceplate of the card. The
	// type is string. Refers to platform.Components_Component_Name
	Name interface{}

	// Reference to system-supplied name of the port that the channel monitor is
	// physically connected to. This port will be of type MONITOR. This port is a
	// tap off of the monitored-port and would be in the same card as the
	// monitored port. If this port is embedded in another card (i.e. an amplifier
	// card) the device should still define a port representing the monitor port
	// if it is internal and not physically present on the faceplate of the card.
	// The type is string. Refers to platform.Components_Component_Name
	MonitorPort interface{}
}

ChannelMonitors_ChannelMonitor_State Operational state data

func (*ChannelMonitors_ChannelMonitor_State) GetEntityData

func (state *ChannelMonitors_ChannelMonitor_State) GetEntityData() *types.CommonEntityData