PcepMetricObjectVer1 (onos-pcepio 1.5.0 API)

java.lang.Object
- org.onosproject.pcepio.protocol.ver1.PcepMetricObjectVer1

All Implemented Interfaces:: PcepMetricObject

public class PcepMetricObjectVer1
extends Object
implements PcepMetricObject

Provides PCEP metric object.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PcepMetricObjectVer1.Builder
Builder class for PCEP metric object.

Nested Classes
Modifier and Type	Class and Description
`static class`	`PcepMetricObjectVer1.Builder` Builder class for PCEP metric object.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BFLAG_RESET`
`static int`	`BFLAG_SET`
`static int`	`BTYPE_SHIFT_VALUE`
`static byte`	`CFLAG_CHECK`
`static int`	`CFLAG_RESET`
`static int`	`CFLAG_SET`
`static int`	`IFLAG_SHIFT_VALUE`
`protected static org.slf4j.Logger`	`log`
`static byte`	`METRIC_OBJ_CLASS`
`static short`	`METRIC_OBJ_MINIMUM_LENGTH`
`static byte`	`METRIC_OBJ_TYPE`
`static byte`	`METRIC_OBJECT_VERSION`
`static int`	`OBJECT_HEADER_LENGTH`

Constructor Summary

Constructors
Constructor and Description
`PcepMetricObjectVer1()` Default constructor.
`PcepMetricObjectVer1(PcepObjectHeader metricObjHeader, int iMetricVal, byte yFlag, boolean bCFlag, boolean bBFlag, byte bType)` Constructor to initialize all member variables.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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.
`PcepObjectHeader`	`getMetricObjHeader()` Returns metric Object Header.
`int`	`getMetricVal()` Returns Metric value in Metric Object.
`byte`	`getYFlag()` Returns Y flag in Metric Object.
`static PcepMetricObject`	`read(org.jboss.netty.buffer.ChannelBuffer cb)` Reads from channel buffer and returns object of PcepMetricObject.
`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`	`setMetricObjHeader(PcepObjectHeader obj)` Sets metric Object Header.
`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.
`String`	`toString()`
`int`	`write(org.jboss.netty.buffer.ChannelBuffer cb)` Writes the Metric Object into channel buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - log
```
protected static final org.slf4j.Logger log
```
  - METRIC_OBJ_TYPE
```
public static final byte METRIC_OBJ_TYPE
```
    See Also:
    
    Constant Field Values
  - METRIC_OBJ_CLASS
```
public static final byte METRIC_OBJ_CLASS
```
    See Also:
    
    Constant Field Values
  - METRIC_OBJECT_VERSION
```
public static final byte METRIC_OBJECT_VERSION
```
    See Also:
    
    Constant Field Values
  - METRIC_OBJ_MINIMUM_LENGTH
```
public static final short METRIC_OBJ_MINIMUM_LENGTH
```
    See Also:
    
    Constant Field Values
  - OBJECT_HEADER_LENGTH
```
public static final int OBJECT_HEADER_LENGTH
```
    See Also:
    
    Constant Field Values
  - IFLAG_SHIFT_VALUE
```
public static final int IFLAG_SHIFT_VALUE
```
    See Also:
    
    Constant Field Values
  - BTYPE_SHIFT_VALUE
```
public static final int BTYPE_SHIFT_VALUE
```
    See Also:
    
    Constant Field Values
  - CFLAG_SET
```
public static final int CFLAG_SET
```
    See Also:
    
    Constant Field Values
  - CFLAG_RESET
```
public static final int CFLAG_RESET
```
    See Also:
    
    Constant Field Values
  - BFLAG_SET
```
public static final int BFLAG_SET
```
    See Also:
    
    Constant Field Values
  - BFLAG_RESET
```
public static final int BFLAG_RESET
```
    See Also:
    
    Constant Field Values
  - CFLAG_CHECK
```
public static final byte CFLAG_CHECK
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PcepMetricObjectVer1
```
public PcepMetricObjectVer1()
```
    Default constructor.
  - PcepMetricObjectVer1
```
public PcepMetricObjectVer1(PcepObjectHeader metricObjHeader,
                            int iMetricVal,
                            byte yFlag,
                            boolean bCFlag,
                            boolean bBFlag,
                            byte bType)
```
    Constructor to initialize all member variables.
    
    Parameters:
    
    metricObjHeader - metric object header
    
    iMetricVal - metric value
    
    yFlag - Y flag
    
    bCFlag - C flag
    
    bBFlag - B flag
    
    bType - Type value
- Method Detail
  - setMetricVal
```
public void setMetricVal(int value)
```
    Description copied from interface: PcepMetricObject
    
    Sets Metric value in Metric Object with specified value.
    
    Specified by:
    
    setMetricVal in interface PcepMetricObject
    
    Parameters:
    
    value - Metric value
  - getMetricVal
```
public int getMetricVal()
```
    Description copied from interface: PcepMetricObject
    
    Returns Metric value in Metric Object.
    
    Specified by:
    
    getMetricVal in interface PcepMetricObject
    
    Returns:
    
    Metric value
  - getYFlag
```
public byte getYFlag()
```
    Description copied from interface: PcepMetricObject
    
    Returns Y flag in Metric Object.
    
    Specified by:
    
    getYFlag in interface PcepMetricObject
    
    Returns:
    
    Y flag in Metric Object
  - setYFlag
```
public void setYFlag(byte value)
```
    Description copied from interface: PcepMetricObject
    
    Sets Y flag in Metric Object with specified value.
    
    Specified by:
    
    setYFlag in interface PcepMetricObject
    
    Parameters:
    
    value - Y flag
  - getCFlag
```
public boolean getCFlag()
```
    Description copied from interface: PcepMetricObject
    
    Returns C flag in Metric Object.
    
    Specified by:
    
    getCFlag in interface PcepMetricObject
    
    Returns:
    
    C flag in Metric Object
  - setCFlag
```
public void setCFlag(boolean value)
```
    Description copied from interface: PcepMetricObject
    
    Sets C flag in Metric Object with specified value.
    
    Specified by:
    
    setCFlag in interface PcepMetricObject
    
    Parameters:
    
    value - C flag
  - getBFlag
```
public boolean getBFlag()
```
    Description copied from interface: PcepMetricObject
    
    Returns B flag in Metric Object.
    
    Specified by:
    
    getBFlag in interface PcepMetricObject
    
    Returns:
    
    B flag in Metric Object
  - setBFlag
```
public void setBFlag(boolean value)
```
    Description copied from interface: PcepMetricObject
    
    Sets B flag in Metric Object with specified value.
    
    Specified by:
    
    setBFlag in interface PcepMetricObject
    
    Parameters:
    
    value - B flag
  - getBType
```
public byte getBType()
```
    Description copied from interface: PcepMetricObject
    
    Returns BType field in Metric Object.
    
    Specified by:
    
    getBType in interface PcepMetricObject
    
    Returns:
    
    BType field in Metric Object
  - setBType
```
public void setBType(byte value)
```
    Description copied from interface: PcepMetricObject
    
    Sets BType field in Metric Object with specified value.
    
    Specified by:
    
    setBType in interface PcepMetricObject
    
    Parameters:
    
    value - BType field
  - setMetricObjHeader
```
public void setMetricObjHeader(PcepObjectHeader obj)
```
    Sets metric Object Header.
    
    Parameters:
    
    obj - metric object header
  - getMetricObjHeader
```
public PcepObjectHeader getMetricObjHeader()
```
    Returns metric Object Header.
    
    Returns:
    
    metricObjHeader
  - read
```
public static PcepMetricObject read(org.jboss.netty.buffer.ChannelBuffer cb)
                             throws PcepParseException
```
    Reads from channel buffer and returns object of PcepMetricObject.
    
    Parameters:
    
    cb - of channel buffer.
    
    Returns:
    
    object of PcepMetricObject
    
    Throws:
    
    PcepParseException - when metric object is not present in channel buffer
  - write
```
public int write(org.jboss.netty.buffer.ChannelBuffer cb)
          throws PcepParseException
```
    Description copied from interface: PcepMetricObject
    
    Writes the Metric Object into channel buffer.
    
    Specified by:
    
    write in interface PcepMetricObject
    
    Parameters:
    
    cb - channel buffer
    
    Returns:
    
    Returns the writerIndex of this buffer
    
    Throws:
    
    PcepParseException - while writing METRIC object into Channel Buffer.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class PcepMetricObjectVer1

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

log

METRIC_OBJ_TYPE

METRIC_OBJ_CLASS

METRIC_OBJECT_VERSION

METRIC_OBJ_MINIMUM_LENGTH

OBJECT_HEADER_LENGTH

IFLAG_SHIFT_VALUE

BTYPE_SHIFT_VALUE

CFLAG_SET

CFLAG_RESET

BFLAG_SET

BFLAG_RESET

CFLAG_CHECK

Constructor Detail

PcepMetricObjectVer1

PcepMetricObjectVer1

Method Detail

setMetricVal

getMetricVal

getYFlag

setYFlag

getCFlag

setCFlag

getBFlag

setBFlag

getBType

setBType

setMetricObjHeader

getMetricObjHeader

read

write

toString