INET Framework for OMNeT++/OMNEST
inet::NextHopInterfaceData Class Reference

Next hop forwarding protocol specific data for an NetworkInterface, stores generic network address. More...

#include <NextHopInterfaceData.h>

Inheritance diagram for inet::NextHopInterfaceData:
inet::InterfaceProtocolData inet::TagBase inet::IPrintableObject

Public Types

enum  { F_ADDRESS, F_METRIC }
 
- Public Types inherited from inet::IPrintableObject
enum  PrintLevel {
  PRINT_LEVEL_TRACE, PRINT_LEVEL_DEBUG, PRINT_LEVEL_DETAIL, PRINT_LEVEL_INFO,
  PRINT_LEVEL_COMPLETE = INT_MIN
}
 
enum  PrintFlag { PRINT_FLAG_FORMATTED = (1 << 0), PRINT_FLAG_MULTILINE = (1 << 1) }
 

Public Member Functions

 NextHopInterfaceData ()
 
virtual std::string str () const override
 
virtual std::string detailedInfo () const
 
Getters
L3Address getAddress () const
 
int getMetric () const
 
Setters
virtual void setAddress (L3Address a)
 
virtual void setMetric (int m)
 
virtual void joinMulticastGroup (L3Address address)
 
- Public Member Functions inherited from inet::InterfaceProtocolData
 InterfaceProtocolData (int id)
 
NetworkInterfacegetNetworkInterface () const
 Returns the NetworkInterface that contains this data object, or nullptr. More...
 
- Public Member Functions inherited from inet::TagBase
virtual const Ptr< TagBasedupShared () const
 
virtual const Ptr< TagBasechangeRegion (b offsetDelta, b lengthDelta) const
 
virtual void parsimPack (cCommBuffer *buffer) const override
 
virtual void parsimUnpack (cCommBuffer *buffer) override
 
virtual std::ostream & printToStream (std::ostream &stream, int level, int evFlags) const override
 Prints this object to the provided output stream. More...
 
virtual std::ostream & printFieldsToStream (std::ostream &stream, int level, int evFlags) const
 
- Public Member Functions inherited from inet::IPrintableObject
virtual ~IPrintableObject ()
 
virtual std::string printToString () const
 
virtual std::string printToString (int level, int evFlags=0) const
 
virtual std::string getInfoStringRepresentation (int evFlags=0) const
 
virtual std::string getDetailStringRepresentation (int evFlags=0) const
 
virtual std::string getDebugStringRepresentation (int evFlags=0) const
 
virtual std::string getTraceStringRepresentation (int evFlags=0) const
 
virtual std::string getCompleteStringRepresentation (int evFlags=0) const
 

Protected Member Functions

void changed1 (int fieldId)
 
- Protected Member Functions inherited from inet::InterfaceProtocolData
virtual void changed (simsignal_t signalID, int fieldId)
 

Protected Attributes

L3Address inetAddr
 address of interface More...
 
int metric
 link "cost"; see e.g. MS KB article Q299540 //TODO needed??? More...
 
- Protected Attributes inherited from inet::InterfaceProtocolData
NetworkInterfaceownerp = nullptr
 
int id
 

Private Member Functions

 NextHopInterfaceData (const NextHopInterfaceData &obj)
 
NextHopInterfaceDataoperator= (const NextHopInterfaceData &obj)
 

Detailed Description

Next hop forwarding protocol specific data for an NetworkInterface, stores generic network address.

See also
NetworkInterface

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
F_ADDRESS 
F_METRIC 
31 { F_ADDRESS, F_METRIC };

Constructor & Destructor Documentation

◆ NextHopInterfaceData() [1/2]

inet::NextHopInterfaceData::NextHopInterfaceData ( const NextHopInterfaceData obj)
private

◆ NextHopInterfaceData() [2/2]

inet::NextHopInterfaceData::NextHopInterfaceData ( )
inline

Member Function Documentation

◆ changed1()

void inet::NextHopInterfaceData::changed1 ( int  fieldId)
inlineprotected

◆ detailedInfo()

std::string inet::NextHopInterfaceData::detailedInfo ( ) const
virtual
23 {
24  std::stringstream out;
25  out << "generic addr:" << getAddress() << "\n"
26  << "Metric: " << getMetric() << "\n";
27  return out.str();
28 }

◆ getAddress()

L3Address inet::NextHopInterfaceData::getAddress ( ) const
inline

◆ getMetric()

int inet::NextHopInterfaceData::getMetric ( ) const
inline
49 { return metric; }

Referenced by detailedInfo().

◆ joinMulticastGroup()

virtual void inet::NextHopInterfaceData::joinMulticastGroup ( L3Address  address)
inlinevirtual
58 {}

◆ operator=()

NextHopInterfaceData& inet::NextHopInterfaceData::operator= ( const NextHopInterfaceData obj)
private

◆ setAddress()

virtual void inet::NextHopInterfaceData::setAddress ( L3Address  a)
inlinevirtual
54 { inetAddr = a; changed1(F_ADDRESS); }

◆ setMetric()

virtual void inet::NextHopInterfaceData::setMetric ( int  m)
inlinevirtual

◆ str()

std::string inet::NextHopInterfaceData::str ( ) const
overridevirtual

Reimplemented from inet::TagBase.

16 {
17  std::stringstream out;
18  out << "generic addr:" << getAddress();
19  return out.str();
20 }

Member Data Documentation

◆ inetAddr

L3Address inet::NextHopInterfaceData::inetAddr
protected

address of interface

◆ metric

int inet::NextHopInterfaceData::metric
protected

link "cost"; see e.g. MS KB article Q299540 //TODO needed???


The documentation for this class was generated from the following files:
inet::InterfaceProtocolData::InterfaceProtocolData
InterfaceProtocolData(int id)
Definition: NetworkInterface.h:62
inet::NextHopInterfaceData::inetAddr
L3Address inetAddr
address of interface
Definition: NextHopInterfaceData.h:26
inet::NextHopInterfaceData::F_ADDRESS
@ F_ADDRESS
Definition: NextHopInterfaceData.h:31
inet::InterfaceProtocolData::changed
virtual void changed(simsignal_t signalID, int fieldId)
Definition: NetworkInterface.cc:50
inet::NetworkInterface::F_NEXTHOP_DATA
@ F_NEXTHOP_DATA
Definition: NetworkInterface.h:150
inet::NextHopInterfaceData::getAddress
L3Address getAddress() const
Definition: NextHopInterfaceData.h:48
inet::units::values::m
value< double, units::m > m
Definition: Units.h:1233
inet::NextHopInterfaceData::changed1
void changed1(int fieldId)
Definition: NextHopInterfaceData.h:34
inet::interfaceGnpConfigChangedSignal
simsignal_t interfaceGnpConfigChangedSignal
Definition: Simsignals.cc:34
inet::NextHopInterfaceData::getMetric
int getMetric() const
Definition: NextHopInterfaceData.h:49
inet::NextHopInterfaceData::F_METRIC
@ F_METRIC
Definition: NextHopInterfaceData.h:31
inet::NextHopInterfaceData::metric
int metric
link "cost"; see e.g. MS KB article Q299540 //TODO needed???
Definition: NextHopInterfaceData.h:27