google_compute_api::InterconnectDiagnosticsLinkOpticalPower Class Reference

#include <interconnect_diagnostics_link_optical_power.h>

Inheritance diagram for google_compute_api::InterconnectDiagnosticsLinkOpticalPower:

Public Member Functions
	InterconnectDiagnosticsLinkOpticalPower (const Json::Value &storage)
	InterconnectDiagnosticsLinkOpticalPower (Json::Value *storage)
virtual	~InterconnectDiagnosticsLinkOpticalPower ()
const StringPiece	GetTypeName () const
bool	has_state () const
void	clear_state ()
const StringPiece	get_state () const
void	set_state (const StringPiece &value)
bool	has_value () const
void	clear_value ()
float	get_value () const
void	set_value (float value)

Static Public Member Functions
static InterconnectDiagnosticsLinkOpticalPower *	New ()

Detailed Description

No description provided.

Constructor & Destructor Documentation

InterconnectDiagnosticsLinkOpticalPower() [1/2]

google_compute_api::InterconnectDiagnosticsLinkOpticalPower::InterconnectDiagnosticsLinkOpticalPower ( const Json::Value &  storage )

explicit

Standard constructor for an immutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

InterconnectDiagnosticsLinkOpticalPower() [2/2]

google_compute_api::InterconnectDiagnosticsLinkOpticalPower::InterconnectDiagnosticsLinkOpticalPower ( Json::Value *  storage )

explicit

Standard constructor for a mutable data object instance.

Parameters

[in]

storage

The underlying data storage for this instance.

~InterconnectDiagnosticsLinkOpticalPower()

google_compute_api::InterconnectDiagnosticsLinkOpticalPower::~InterconnectDiagnosticsLinkOpticalPower ( )

virtual

Standard destructor.

Member Function Documentation

clear_state()

void google_compute_api::InterconnectDiagnosticsLinkOpticalPower::clear_state ( )

inline

Clears the 'state' attribute.

clear_value()

void google_compute_api::InterconnectDiagnosticsLinkOpticalPower::clear_value ( )

inline

Clears the 'value' attribute.

get_state()

const StringPiece google_compute_api::InterconnectDiagnosticsLinkOpticalPower::get_state ( ) const

inline

Get the value of the 'state' attribute.

get_value()

float google_compute_api::InterconnectDiagnosticsLinkOpticalPower::get_value ( ) const

inline

Get the value of the 'value' attribute.

GetTypeName()

const StringPiece google_compute_api::InterconnectDiagnosticsLinkOpticalPower::GetTypeName ( ) const

inline

Returns a string denoting the type of this data object.

Returns

google_compute_api::InterconnectDiagnosticsLinkOpticalPower

has_state()

bool google_compute_api::InterconnectDiagnosticsLinkOpticalPower::has_state ( ) const

inline

Determine if the 'state' attribute was set.

Returns

true if the 'state' attribute was set.

has_value()

bool google_compute_api::InterconnectDiagnosticsLinkOpticalPower::has_value ( ) const

inline

Determine if the 'value' attribute was set.

Returns

true if the 'value' attribute was set.

New()

InterconnectDiagnosticsLinkOpticalPower * google_compute_api::InterconnectDiagnosticsLinkOpticalPower::New ( )

static

Creates a new default instance.

Returns

Ownership is passed back to the caller.

set_state()

void google_compute_api::InterconnectDiagnosticsLinkOpticalPower::set_state ( const StringPiece &  value )

inline

Change the 'state' attribute.

The status of the current value when compared to the warning and alarm levels for the receiving or transmitting transceiver. Possible states include:

OK

The value has not crossed a warning threshold.

LOW_WARNING

The value has crossed below the low warning threshold.

HIGH_WARNING

The value has crossed above the high warning threshold.

LOW_ALARM

The value has crossed below the low alarm threshold.

HIGH_ALARM

The value has crossed above the high alarm threshold.

Parameters

[in]

value

The new value.

set_value()

void google_compute_api::InterconnectDiagnosticsLinkOpticalPower::set_value ( float  value )

inline

Change the 'value' attribute.

Value of the current receiving or transmitting optical power, read in dBm. Take a known good optical value, give it a 10% margin and trigger warnings relative to that value. In general, a -7dBm warning and a -11dBm alarm are good optical value estimates for most links.

Parameters

[in]

value

The new value.

---

The documentation for this class was generated from the following files:

• google/compute_api/interconnect_diagnostics_link_optical_power.h
• google/compute_api/interconnect_diagnostics_link_optical_power.cc