org.onosproject.pcepio.protocol

Interface PcepMetricObject

All Known Implementing Classes:

PcepMetricObjectVer1

public interface PcepMetricObject

Abstraction of an entity providing PCEP Metric Object.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PcepMetricObject.Builder Builder interface with get and set functions to build Metric object.

Method Summary

Modifier and Type	Method and Description
boolean	getBFlag() Returns B flag in Metric Object.
byte	getBType() Returns BType field in Metric Object.
boolean	getCFlag() Returns C flag in Metric Object.
int	getMetricVal() Returns Metric value in Metric Object.
byte	getYFlag() Returns Y flag in Metric Object.
void	setBFlag(boolean value) Sets B flag in Metric Object with specified value.
void	setBType(byte value) Sets BType field in Metric Object with specified value.
void	setCFlag(boolean value) Sets C flag in Metric Object with specified value.
void	setMetricVal(int value) Sets Metric value in Metric Object with specified value.
void	setYFlag(byte value) Sets Y flag in Metric Object with specified value.
int	write(org.jboss.netty.buffer.ChannelBuffer bb) Writes the Metric Object into channel buffer.

Method Detail

getMetricVal

int getMetricVal()

Returns Metric value in Metric Object.

Returns:

Metric value

setMetricVal

void setMetricVal(int value)

Sets Metric value in Metric Object with specified value.

Parameters:

value - Metric value

getYFlag

byte getYFlag()

Returns Y flag in Metric Object.

Returns:

Y flag in Metric Object

setYFlag

void setYFlag(byte value)

Sets Y flag in Metric Object with specified value.

Parameters:

value - Y flag

getCFlag

boolean getCFlag()

Returns C flag in Metric Object.

Returns:

C flag in Metric Object

setCFlag

void setCFlag(boolean value)

Sets C flag in Metric Object with specified value.

Parameters:

value - C flag

getBFlag

boolean getBFlag()

Returns B flag in Metric Object.

Returns:

B flag in Metric Object

setBFlag

void setBFlag(boolean value)

Sets B flag in Metric Object with specified value.

Parameters:

value - B flag

getBType

byte getBType()

Returns BType field in Metric Object.

Returns:

BType field in Metric Object

setBType

void setBType(byte value)

Sets BType field in Metric Object with specified value.

Parameters:

value - BType field

write

int write(org.jboss.netty.buffer.ChannelBuffer bb)
   throws PcepParseException

Writes the Metric Object into channel buffer.

Parameters:

bb - channel buffer

Returns:

Returns the writerIndex of this buffer

Throws:

PcepParseException - while writing METRIC object into Channel Buffer.