N5gGNBFunction (ITNM Collector Framework v4.2 FP24 API)

Nested Class Summary
- Nested classes/interfaces inherited from class com.ibm.tivoli.nm.collectors.framework.store.N5gFunction
  N5gFunction.eConnectionType, N5gFunction.eFunctionType

Field Summary
- Fields inherited from class com.ibm.tivoli.nm.collectors.framework.store.N5gFunction
  connectionMap, interfaceVec, m_Attributes, m_Name, m_Vendor

Constructor Summary

Constructors
Constructor and Description

N5gGNBFunction(java.util.Map<java.lang.String,java.lang.Object> data)
Constructor, should be called via Add method in LTEDataStore

Constructors
Constructor and Description
`N5gGNBFunction(java.util.Map<java.lang.String,java.lang.Object> data)` Constructor, should be called via Add method in `LTEDataStore`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LTEAntennaFunction`	`addAntennaFunction(java.lang.String antennaSerial, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an Antenna to the list
`void`	`addConnectedAmf(java.lang.String amfName, java.util.Map<java.lang.String,java.lang.Object> data)`
`void`	`addConnectedMME(java.lang.String mmeName, java.util.Map<java.lang.String,java.lang.Object> data)` Add a connected MME to the list
`void`	`addConnectedSAEGateway(java.lang.String saeName, java.util.Map<java.lang.String,java.lang.Object> data)` Add a connected SGW to the list
`void`	`addConnectedSGW(java.lang.String sgwName, java.util.Map<java.lang.String,java.lang.Object> data)` Add a connected SGW to the list
`void`	`addConnectedUpf(java.lang.String upfName, java.util.Map<java.lang.String,java.lang.Object> data)`
`void`	`addConnection(N5gFunction.eConnectionType type, java.lang.String nbrName, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an LTE connection to the list
`void`	`addE1Neighbour(java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an E1 connection to the list
`void`	`addF1CNeighbour(java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an F1C connection to the list
`void`	`addF1UNeighbour(java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an F1U connection to the list
`N5gLogicalElement`	`addNRCell(N5gLogicalElement.eLogicalType type, java.lang.String cellId, java.util.Map<java.lang.String,java.lang.Object> data)` Add a connected NRCellCU/NRCellDU to the list
`N5gNRSector`	`addNRSector(java.lang.String sectorId, java.util.Map<java.lang.String,java.lang.Object> data)` Add a connected N5gNRSector to the list
`void`	`addX2CNeighbour(java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an X2C connection to the list
`void`	`addX2Neighbour(java.lang.String adjENBId, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an X2 ENB connection to the list
`void`	`addX2UNeighbour(java.lang.String adjGNBId, java.util.Map<java.lang.String,java.lang.Object> data)` Adds an X2U connection to the list
`java.util.Iterator<LTEAntennaFunction>`	`getAntennaVecItr()` Get an iterator to the antenna vector
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getE1VecItr()`
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getF1CVecItr()`
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getF1UVecItr()`
`N5gFunction.eFunctionType`	`getGnbFuncType()`
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getMMEVecItr()` Get an iterator to the connected MME vector
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getN2VecItr()`
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getN3VecItr()`
`java.util.Iterator<N5gNRCellCU>`	`getNrCellCUVecItr()` Get an iterator to the NRCellCU vector
`java.util.Iterator<N5gNRCellDU>`	`getNrCellDUVecItr()` Get an iterator to the NRCellDU vector
`java.util.Iterator<N5gNRSector>`	`getNrSectorVecItr()` Get an iterator to the N5gNRSector vector
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getPGWVecItr()` Get an iterator to the connected PGW vector
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getSAEGatewayVecItr()` Get an iterator to the connected SAEGateway vector
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getSGWVecItr()` Get an iterator to the connected SGW vector
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getX2CVecItr()`
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getX2UVecItr()`
`java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>>`	`getX2VecItr()` Get an iterator to the X2 connection vector
`protected void`	`Initialise()`
`void`	`setGnbFuncType(N5gFunction.eFunctionType type)`

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.store.N5gFunction
add5GInterface, addPlmn, get5GInterfaceItr, getAttributes, getConnectionItr, getPlmnsItr, InitialiseMembers

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

Constructor Detail
- N5gGNBFunction
```
public N5gGNBFunction(java.util.Map<java.lang.String,java.lang.Object> data)
```
  Constructor, should be called via Add method in LTEDataStore
  
  Parameters:
  
  name - The given name for this ENB Function
  
  vendor - The vendor of the ENB function
  
  data - A Map containing data objects relevant to an ENB Function

Method Detail

getMMEVecItr
```
public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getMMEVecItr()
```
Get an iterator to the connected MME vector

Returns:

an iterator to the connected MME vector

getX2CVecItr

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getX2CVecItr()

getX2UVecItr

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getX2UVecItr()

getSGWVecItr
```
public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getSGWVecItr()
```
Get an iterator to the connected SGW vector

Returns:

an iterator to the connected SGW vector

getSAEGatewayVecItr
```
public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getSAEGatewayVecItr()
```
Get an iterator to the connected SAEGateway vector

Returns:

an iterator to the connected SAEGateway vector

getPGWVecItr
```
public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getPGWVecItr()
```
Get an iterator to the connected PGW vector

Returns:

an iterator to the connected PGW vector

getNrSectorVecItr
```
public java.util.Iterator<N5gNRSector> getNrSectorVecItr()
```
Get an iterator to the N5gNRSector vector

Returns:

an iterator to the N5gNRSector vector

getNrCellCUVecItr
```
public java.util.Iterator<N5gNRCellCU> getNrCellCUVecItr()
```
Get an iterator to the NRCellCU vector

Returns:

an iterator to the NRCellCU vector

getNrCellDUVecItr
```
public java.util.Iterator<N5gNRCellDU> getNrCellDUVecItr()
```
Get an iterator to the NRCellDU vector

Returns:

an iterator to the NRCellDU vector

getX2VecItr
```
public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getX2VecItr()
```
Get an iterator to the X2 connection vector

Returns:

an iterator to the X2 connection vector

addConnectedAmf

public void addConnectedAmf(java.lang.String amfName,
                            java.util.Map<java.lang.String,java.lang.Object> data)

addConnectedUpf

public void addConnectedUpf(java.lang.String upfName,
                            java.util.Map<java.lang.String,java.lang.Object> data)

getN2VecItr

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getN2VecItr()

getN3VecItr

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getN3VecItr()

getE1VecItr

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getE1VecItr()

getF1CVecItr

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getF1CVecItr()

getF1UVecItr

public java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> getF1UVecItr()

getAntennaVecItr
```
public java.util.Iterator<LTEAntennaFunction> getAntennaVecItr()
```
Get an iterator to the antenna vector

Returns:

an iterator to the antenna vector

Initialise
```
protected void Initialise()
```

addConnectedMME

public void addConnectedMME(java.lang.String mmeName,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Add a connected MME to the list

Parameters:: mmeName - The name of the connected MME; data - A map of other connection info

addConnectedSGW

public void addConnectedSGW(java.lang.String sgwName,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Add a connected SGW to the list

Parameters:: sgwName - The name of the connected SGW; data - A map of other connection info

addConnectedSAEGateway

public void addConnectedSAEGateway(java.lang.String saeName,
                                   java.util.Map<java.lang.String,java.lang.Object> data)

Add a connected SGW to the list

Parameters:: sgwName - The name of the connected SGW; data - A map of other connection info

addNRSector

public N5gNRSector addNRSector(java.lang.String sectorId,
                               java.util.Map<java.lang.String,java.lang.Object> data)

Add a connected N5gNRSector to the list

Parameters:: sectorId - The id of the sector; data - A map of other sector info

addNRCell

public N5gLogicalElement addNRCell(N5gLogicalElement.eLogicalType type,
                                   java.lang.String cellId,
                                   java.util.Map<java.lang.String,java.lang.Object> data)

Add a connected NRCellCU/NRCellDU to the list

Parameters:: cellId - The id of the cell; data - A map of other cell info

addX2CNeighbour

public void addX2CNeighbour(java.lang.String adjGNBId,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds an X2C connection to the list

Parameters:: adjGNBId - The id of the connected GNodeB; data - A map of other relevant data

addE1Neighbour

public void addE1Neighbour(java.lang.String adjGNBId,
                           java.util.Map<java.lang.String,java.lang.Object> data)

Adds an E1 connection to the list

Parameters:: adjGNBId - The id of the connected GNodeB; data - A map of other relevant data

addF1CNeighbour

public void addF1CNeighbour(java.lang.String adjGNBId,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds an F1C connection to the list

Parameters:: adjGNBId - The id of the connected GNodeB; data - A map of other relevant data

addF1UNeighbour

public void addF1UNeighbour(java.lang.String adjGNBId,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds an F1U connection to the list

Parameters:: adjGNBId - The id of the connected GNodeB; data - A map of other relevant data

addX2Neighbour

public void addX2Neighbour(java.lang.String adjENBId,
                           java.util.Map<java.lang.String,java.lang.Object> data)

Adds an X2 ENB connection to the list

Parameters:: adjENBId - The id of the connected ENodeB; data - A map of other relevant data

addX2UNeighbour

public void addX2UNeighbour(java.lang.String adjGNBId,
                            java.util.Map<java.lang.String,java.lang.Object> data)

Adds an X2U connection to the list

Parameters:: adjGNBId - The id of the connected GNodeB; data - A map of other relevant data

addAntennaFunction

public LTEAntennaFunction addAntennaFunction(java.lang.String antennaSerial,
                                             java.util.Map<java.lang.String,java.lang.Object> data)

Adds an Antenna to the list

Parameters:: antennaSerial - The id of the connected GNodeB; data - A map of other relevant antenna data
Returns:: A reference to the new Antenna

addConnection

public void addConnection(N5gFunction.eConnectionType type,
                          java.lang.String nbrName,
                          java.util.Map<java.lang.String,java.lang.Object> data)

Adds an LTE connection to the list

Specified by:: addConnection in class N5gFunction
Parameters:: type - The connection type; nbrName - The id of the remote nbr; data - A Map of other connection data

getGnbFuncType

public N5gFunction.eFunctionType getGnbFuncType()

setGnbFuncType

public void setGnbFuncType(N5gFunction.eFunctionType type)

Class N5gGNBFunction

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.tivoli.nm.collectors.framework.store.N5gFunction

Field Summary

Fields inherited from class com.ibm.tivoli.nm.collectors.framework.store.N5gFunction

Constructor Summary

Method Summary

Methods inherited from class com.ibm.tivoli.nm.collectors.framework.store.N5gFunction

Methods inherited from class java.lang.Object

Constructor Detail

N5gGNBFunction