QKD graphs are implemented to allow straightforward access to QKD buffers' state and convenient monitoring of key material consumption. More...

#include "qkd-graph.h"

Inheritance diagram for ns3::QKDGraph:

Collaboration diagram for ns3::QKDGraph:

Public Member Functions
	QKDGraph (Ptr< Node > src, Ptr< Node > dst, uint32_t bufferID, std::string graphTitle, std::string graphType, Ptr< QBuffer > buff)
	Constructor.

	~QKDGraph () override
	Destructor.

void	InitTotalGraph () const
	Initialized function for total graph.

void	PrintGraph ()
	Print the graph.

void	ProcessMCurrent (uint32_t value)
	MCurrent value of the QBuffer changed, so plot it on the graph.

void	ProcessMStatus (uint32_t value)
	The status of the QBuffer changed, so plot it on the graph.

void	ProcessMStatusHelpFunction (double time, uint32_t newValue)
	Help function for detection of status change value.

void	ProcessMThrStatus (uint32_t value)
	The Mthr value of the QBuffer changed, so plot it on the graph.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Attributes
Ptr< QBuffer >	m_buffer
	QBuffer associated with the QKDGraph.

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

Ptr< Node >	m_dst
	destination node, info required for graph title

Gnuplot	m_gnuplot
	Gluplot object settings.

uint32_t	m_graphStatusEntry
	temp variable

uint32_t	m_keymCurrent
	get some boundaries for the graph

uint32_t	m_keymMax
	get some boundaries for the graph

uint32_t	m_keymMin
	get some boundaries for the graph

uint32_t	m_keymThreshold
	get some boundaries for the graph

uint32_t	m_maxValueGraph
	get some boundaries for the graph

std::string	m_plotFileName
	output filename

std::string	m_plotFileType

double	m_simulationTime
	time value, x-axis

Ptr< Node >	m_src
	source node, info required for graph title

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

QKD graphs are implemented to allow straightforward access to QKD buffers' state and convenient monitoring of key material consumption.

Note: 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.

Config Paths

ns3::QKDGraph is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/ApplicationList/[i]/$ns3::QKDKeyManagerSystemApplication/BufferList/[i]"

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

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

Constructor & Destructor Documentation

◆ QKDGraph()

ns3::QKDGraph::QKDGraph	(	Ptr< Node >	src,
		Ptr< Node >	dst,
		uint32_t	bufferID,
		std::string	graphTitle,
		std::string	graphType,
		Ptr< QBuffer >	buff
	)

Constructor.

Parameters

Ptr<QKDControl>	control
Ptr<Node>	src
Ptr<Node>	dst
uint32_t	bufferID
std::string	graphTitle
std::string	graphType

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

References ns3::Gnuplot2dDataset::Add(), ns3::Gnuplot::AppendExtra(), ns3::Create(), ns3::Gnuplot2dDataset::FILLEDCURVE, ns3::Node::GetId(), ns3::Gnuplot2dDataset::LINES_POINTS, m_buffer, m_dataset, m_datasetMaximum, m_datasetMinimum, m_datasetThreshold, m_datasetWorkingState_0, m_datasetWorkingState_1, m_datasetWorkingState_2, m_datasetWorkingState_3, m_dst, m_gnuplot, m_graphStatusEntry, m_keymCurrent, m_keymMax, m_keymMin, m_keymThreshold, m_maxValueGraph, m_plotFileName, m_plotFileType, m_src, NS_ASSERT, NS_LOG_FUNCTION, ProcessMStatusHelpFunction(), ns3::GnuplotDataset::SetExtra(), ns3::Gnuplot::SetLegend(), ns3::Gnuplot::SetOutputFilename(), ns3::Gnuplot2dDataset::SetStyle(), ns3::GnuplotDataset::SetTitle(), and ns3::Gnuplot::SetTitle().

Here is the call graph for this function:

◆ ~QKDGraph()

ns3::QKDGraph::~QKDGraph ( )

override

Destructor.

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

Member Function Documentation

◆ GetTypeId()

TypeId ns3::QKDGraph::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ InitTotalGraph()

void ns3::QKDGraph::InitTotalGraph ( ) const

Initialized function for total graph.

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

References m_buffer.

◆ PrintGraph()

void ns3::QKDGraph::PrintGraph ( )

Print the graph.

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

References ns3::Gnuplot2dDataset::Add(), ns3::Gnuplot::AddDataset(), ns3::Gnuplot::AppendExtra(), ns3::Create(), ns3::Gnuplot::GenerateOutput(), ns3::Node::GetId(), m_buffer, m_dataset, m_datasetMaximum, m_datasetMinimum, m_datasetThreshold, m_datasetWorkingState_0, m_datasetWorkingState_1, m_datasetWorkingState_2, m_datasetWorkingState_3, m_dst, m_gnuplot, m_keymMax, m_keymMin, m_maxValueGraph, m_plotFileName, m_simulationTime, m_src, NS_LOG_FUNCTION, and ProcessMStatusHelpFunction().

Here is the call graph for this function:

◆ ProcessMCurrent()

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

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

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

References ns3::Gnuplot2dDataset::Add(), ns3::Create(), ns3::Node::GetId(), ns3::Time::GetSeconds(), m_dataset, m_dst, m_maxValueGraph, m_simulationTime, m_src, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ ProcessMStatus()

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

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

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

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

Here is the call graph for this function:

◆ ProcessMStatusHelpFunction()

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(), ns3::Create(), ns3::Node::GetId(), m_buffer, m_datasetWorkingState_0, m_datasetWorkingState_1, m_datasetWorkingState_2, m_datasetWorkingState_3, m_dst, m_graphStatusEntry, m_src, and NS_LOG_FUNCTION.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ProcessMThrStatus()

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

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

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

References ns3::Gnuplot2dDataset::Add(), ns3::Create(), ns3::Node::GetId(), ns3::Time::GetSeconds(), m_datasetThreshold, m_dst, m_simulationTime, m_src, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ m_buffer

Ptr< QBuffer > ns3::QKDGraph::m_buffer

private

QBuffer associated with the QKDGraph.

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

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

◆ m_dataset

Gnuplot2dDataset ns3::QKDGraph::m_dataset

private

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

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

◆ m_datasetMaximum

Gnuplot2dDataset ns3::QKDGraph::m_datasetMaximum

private

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

Referenced by QKDGraph(), and PrintGraph().

◆ m_datasetMinimum

Gnuplot2dDataset ns3::QKDGraph::m_datasetMinimum

private

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

Referenced by QKDGraph(), and PrintGraph().

◆ m_datasetThreshold

Gnuplot2dDataset ns3::QKDGraph::m_datasetThreshold

private

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

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

◆ m_datasetWorkingState_0

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_0

private

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

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

◆ m_datasetWorkingState_1

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_1

private

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

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

◆ m_datasetWorkingState_2

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_2

private

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

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

◆ m_datasetWorkingState_3

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_3

private

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

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

◆ m_datasetWorkingState_Mthr

Gnuplot2dDataset ns3::QKDGraph::m_datasetWorkingState_Mthr

private

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

◆ m_dst

Ptr< Node > ns3::QKDGraph::m_dst

private

destination node, info required for graph title

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

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

◆ m_gnuplot

Gnuplot ns3::QKDGraph::m_gnuplot

private

Gluplot object settings.

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

Referenced by QKDGraph(), and PrintGraph().

◆ m_graphStatusEntry

uint32_t ns3::QKDGraph::m_graphStatusEntry

private

temp variable

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

Referenced by QKDGraph(), and ProcessMStatusHelpFunction().

◆ m_keymCurrent

uint32_t ns3::QKDGraph::m_keymCurrent

private

get some boundaries for the graph

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

Referenced by QKDGraph().

◆ m_keymMax

uint32_t ns3::QKDGraph::m_keymMax

private

get some boundaries for the graph

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

Referenced by QKDGraph(), and PrintGraph().

◆ m_keymMin

uint32_t ns3::QKDGraph::m_keymMin

private

get some boundaries for the graph

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

Referenced by QKDGraph(), and PrintGraph().

◆ m_keymThreshold

uint32_t ns3::QKDGraph::m_keymThreshold

private

get some boundaries for the graph

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

Referenced by QKDGraph().

◆ m_maxValueGraph

uint32_t ns3::QKDGraph::m_maxValueGraph

private

get some boundaries for the graph

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

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

◆ m_plotFileName

std::string ns3::QKDGraph::m_plotFileName

private

output filename

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

Referenced by QKDGraph(), and PrintGraph().

◆ m_plotFileType

std::string ns3::QKDGraph::m_plotFileType

private

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

Referenced by QKDGraph().

◆ m_simulationTime

double ns3::QKDGraph::m_simulationTime

private

time value, x-axis

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

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

◆ m_src

Ptr< Node > ns3::QKDGraph::m_src

private

source node, info required for graph title

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

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

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

src/qkd/model/qkd-graph.h
src/qkd/model/qkd-graph.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Constructor & Destructor Documentation

◆ QKDGraph()

◆ ~QKDGraph()

Member Function Documentation

◆ GetTypeId()

◆ InitTotalGraph()

◆ PrintGraph()

◆ ProcessMCurrent()

◆ ProcessMStatus()

◆ ProcessMStatusHelpFunction()

◆ ProcessMThrStatus()

Member Data Documentation

◆ m_buffer

◆ m_dataset

◆ m_datasetMaximum

◆ m_datasetMinimum

◆ m_datasetThreshold

◆ m_datasetWorkingState_0

◆ m_datasetWorkingState_1

◆ m_datasetWorkingState_2

◆ m_datasetWorkingState_3

◆ m_datasetWorkingState_Mthr

◆ m_dst

◆ m_gnuplot

◆ m_graphStatusEntry

◆ m_keymCurrent

◆ m_keymMax

◆ m_keymMin

◆ m_keymThreshold

◆ m_maxValueGraph

◆ m_plotFileName

◆ m_plotFileType

◆ m_simulationTime

◆ m_src