A Discrete-Event Network Simulator
API
ns3::QKDGraph Class Reference

Introspection did not find any typical Config paths. More...

#include "qkd-graph.h"

+ Inheritance diagram for ns3::QKDGraph:
+ Collaboration diagram for ns3::QKDGraph:

Public Member Functions

 QKDGraph (uint32_t nodeID, uint32_t bufferID, std::string graphTitle, std::string graphType)
 Constructor. More...
 
virtual ~QKDGraph ()
 Destructor. More...
 
void InitTotalGraph () const
 Initialized function for total graph. More...
 
void PrintGraph ()
 Print the graph. More...
 
void ProcessMCurrent (uint32_t value)
 MCurrent value of the QKDBuffer changed, so plot it on the graph. More...
 
void ProcessMStatus (uint32_t value)
 The status of the QKDBuffer changed, so plot it on the graph. More...
 
void ProcessMStatusHelpFunction (double time, uint32_t newValue)
 Help function for detection of status change value. More...
 
void ProcessMThrStatus (uint32_t value)
 The Mthr value of the QKDBuffer changed, so plot it on the graph. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

Ptr< QKDBufferbuffer
 QKDBuffer associated with the QKDGraph. More...
 
Gnuplot2dDataset m_dataset
 
Gnuplot2dDataset m_datasetMaximum
 
Gnuplot2dDataset m_datasetMinimum
 
Gnuplot2dDataset m_datasetThreshold
 
Gnuplot2dDataset m_datasetWorkingState_0
 
Gnuplot2dDataset m_datasetWorkingState_1
 
Gnuplot2dDataset m_datasetWorkingState_2
 
Gnuplot2dDataset m_datasetWorkingState_3
 
Gnuplot2dDataset m_datasetWorkingState_Mthr
 
uint32_t m_destinationNode
 destination node ID, info required for graph title More...
 
uint32_t m_destinationNodeDeviceId
 destination node device ID, info required for graph title More...
 
Gnuplot m_gnuplot
 
uint32_t m_graphStatusEntry
 temp variable More...
 
uint32_t m_keymCurrent
 get some boundaries for the graph More...
 
uint32_t m_keymMax
 get some boundaries for the graph More...
 
uint32_t m_keymMin
 get some boundaries for the graph More...
 
uint32_t m_keymThreshold
 get some boundaries for the graph More...
 
std::string m_plotFileName
 output filename More...
 
std::string m_plotFileType
 
double m_simulationTime
 time value, x-axis More...
 
uint32_t m_sourceNode
 source node ID, info required for graph title More...
 
uint32_t m_sourceNodeDeviceId
 source node device ID, info required for graph title More...
 
uint32_t m_tempMax
 get some boundaries for the graph More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

Introspection did not find any typical Config paths.

QKD graphs are implemented to allow easier access to the state of QKD buffers and easier monitoring of key material consumption.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 456 bytes (on a 64-bit architecture).

QKD graph is associated with QKD buffer which allows plotting of graphs on each node with associated QKD link and QKD buffer. QKD Graph creates separate PLT and DAT files which are suitable for plotting using popular Gnuplot tool in PNG (default), SVG or EPSLATEX format. QKDNetSim supports plotting of QKD Total Graph which is used to show the overall consumption of key material in QKD Network. QKD Total Graph is updated each time when key material is generated or consumed on a network link.

Definition at line 47 of file qkd-graph.h.

Constructor & Destructor Documentation

ns3::QKDGraph::~QKDGraph ( )
virtual

Destructor.

Definition at line 37 of file qkd-graph.cc.

Member Function Documentation

TypeId ns3::QKDGraph::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

Definition at line 29 of file qkd-graph.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::QKDGraph::InitTotalGraph ( ) const

Initialized function for total graph.

Definition at line 232 of file qkd-graph.cc.

References buffer.

void ns3::QKDGraph::ProcessMCurrent ( uint32_t  value)

MCurrent value of the QKDBuffer changed, so plot it on the graph.

Definition at line 239 of file qkd-graph.cc.

References ns3::Gnuplot2dDataset::Add(), ns3::Time::GetSeconds(), m_dataset, m_destinationNode, m_simulationTime, m_sourceNode, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::QKDGraph::ProcessMStatus ( uint32_t  value)

The status of the QKDBuffer changed, so plot it on the graph.

Definition at line 291 of file qkd-graph.cc.

References ns3::Time::GetSeconds(), m_simulationTime, ns3::Simulator::Now(), NS_LOG_FUNCTION, and ProcessMStatusHelpFunction().

+ Here is the call graph for this function:

void ns3::QKDGraph::ProcessMStatusHelpFunction ( double  time,
uint32_t  newValue 
)

Help function for detection of status change value.

Definition at line 255 of file qkd-graph.cc.

References ns3::Gnuplot2dDataset::Add(), m_datasetWorkingState_0, m_datasetWorkingState_1, m_datasetWorkingState_2, m_datasetWorkingState_3, m_destinationNode, m_graphStatusEntry, m_keymMax, m_sourceNode, and NS_LOG_FUNCTION.

Referenced by PrintGraph(), ProcessMStatus(), and QKDGraph().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::QKDGraph::ProcessMThrStatus ( uint32_t  value)

The Mthr value of the QKDBuffer changed, so plot it on the graph.

Definition at line 247 of file qkd-graph.cc.

References ns3::Gnuplot2dDataset::Add(), ns3::Time::GetSeconds(), m_datasetThreshold, m_destinationNode, m_simulationTime, m_sourceNode, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

Member Data Documentation

Ptr<QKDBuffer> ns3::QKDGraph::buffer
private

QKDBuffer associated with the QKDGraph.

Definition at line 108 of file qkd-graph.h.

Referenced by InitTotalGraph(), PrintGraph(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_dataset
private

Definition at line 126 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMCurrent(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_datasetMaximum
private

Definition at line 134 of file qkd-graph.h.

Referenced by PrintGraph(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_datasetMinimum
private

Definition at line 133 of file qkd-graph.h.

Referenced by PrintGraph(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_datasetThreshold
private

Definition at line 132 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMThrStatus(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_0
private

Definition at line 128 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMStatusHelpFunction(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_1
private

Definition at line 129 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMStatusHelpFunction(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_2
private

Definition at line 130 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMStatusHelpFunction(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_3
private

Definition at line 131 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMStatusHelpFunction(), and QKDGraph().

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_Mthr
private

Definition at line 127 of file qkd-graph.h.

uint32_t ns3::QKDGraph::m_destinationNode
private

destination node ID, info required for graph title

Definition at line 110 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMCurrent(), ProcessMStatusHelpFunction(), ProcessMThrStatus(), and QKDGraph().

uint32_t ns3::QKDGraph::m_destinationNodeDeviceId
private

destination node device ID, info required for graph title

Definition at line 112 of file qkd-graph.h.

Gnuplot ns3::QKDGraph::m_gnuplot
private

Definition at line 125 of file qkd-graph.h.

Referenced by PrintGraph(), and QKDGraph().

uint32_t ns3::QKDGraph::m_graphStatusEntry
private

temp variable

Definition at line 123 of file qkd-graph.h.

Referenced by ProcessMStatusHelpFunction(), and QKDGraph().

uint32_t ns3::QKDGraph::m_keymCurrent
private

get some boundaries for the graph

Definition at line 115 of file qkd-graph.h.

Referenced by QKDGraph().

uint32_t ns3::QKDGraph::m_keymMax
private

get some boundaries for the graph

Definition at line 116 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMStatusHelpFunction(), and QKDGraph().

uint32_t ns3::QKDGraph::m_keymMin
private

get some boundaries for the graph

Definition at line 114 of file qkd-graph.h.

Referenced by PrintGraph(), and QKDGraph().

uint32_t ns3::QKDGraph::m_keymThreshold
private

get some boundaries for the graph

Definition at line 118 of file qkd-graph.h.

Referenced by QKDGraph().

std::string ns3::QKDGraph::m_plotFileName
private

output filename

Definition at line 120 of file qkd-graph.h.

Referenced by PrintGraph(), and QKDGraph().

std::string ns3::QKDGraph::m_plotFileType
private

Definition at line 121 of file qkd-graph.h.

Referenced by QKDGraph().

double ns3::QKDGraph::m_simulationTime
private

time value, x-axis

Definition at line 122 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMCurrent(), ProcessMStatus(), and ProcessMThrStatus().

uint32_t ns3::QKDGraph::m_sourceNode
private

source node ID, info required for graph title

Definition at line 109 of file qkd-graph.h.

Referenced by PrintGraph(), ProcessMCurrent(), ProcessMStatusHelpFunction(), ProcessMThrStatus(), and QKDGraph().

uint32_t ns3::QKDGraph::m_sourceNodeDeviceId
private

source node device ID, info required for graph title

Definition at line 111 of file qkd-graph.h.

uint32_t ns3::QKDGraph::m_tempMax
private

get some boundaries for the graph

Definition at line 117 of file qkd-graph.h.

Referenced by QKDGraph().


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