QKDTotalGraph is implemented to allow easier access to the state of ALL QKD buffers and easier monitoring of the overall key material consumption. More...

#include "qkd-total-graph.h"

Inheritance diagram for ns3::QKDTotalGraph:

Collaboration diagram for ns3::QKDTotalGraph:

Public Member Functions
	QKDTotalGraph ()
	Constructor. More...

	QKDTotalGraph (std::string graphName, std::string graphType)
	Constructor. More...

virtual	~QKDTotalGraph ()
	Destructor. More...

void	Init (std::string graphName, std::string graphType)
	Initialized function used in constructor. More...

void	PrintGraph ()
	Print the graph. More...

void	ProcessMCurrent (uint32_t value, char sign)
	MCurrent value of the QKDBuffer changed, so plot it on the graph. More...

void	ProcessMThr (uint32_t value, char sign)
	Mthr value of the QKDBuffer changed, so plot it on the graph. More...

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

	~Object () override
	Destructor. More...

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

void	Dispose ()
	Dispose of this Object. More...

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

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

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

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

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

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

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

bool	IsInitialized () 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[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...

void	Ref () const
	Increment the reference count. More...

void	Unref () 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 errors. 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 ()
	Register this type. More...

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

Private Attributes
Gnuplot2dDataset	m_dataset

Gnuplot2dDataset	m_datasetThreshold

Gnuplot	m_gnuplot

uint32_t	m_keymCurrent
	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...

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

virtual void	DoDispose ()
	Destructor implementation. More...

virtual void	DoInitialize ()
	Initialize() implementation. More...

virtual void	NotifyNewAggregate ()
	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 ()
	Notifier called once the ObjectBase is fully constructed. More...

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

Detailed Description

QKDTotalGraph is implemented to allow easier access to the state of ALL QKD buffers and easier monitoring of the overall key material consumption.

Note: QKDTotalGraph 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. Only one QKDTotalGraph in the whole simulation is allowed!

Definition at line 43 of file qkd-total-graph.h.

Constructor & Destructor Documentation

◆ QKDTotalGraph() [1/2]

ns3::QKDTotalGraph::QKDTotalGraph ( )

Constructor.

Definition at line 39 of file qkd-total-graph.cc.

References Init().

Here is the call graph for this function:

◆ QKDTotalGraph() [2/2]

ns3::QKDTotalGraph::QKDTotalGraph	(	std::string	graphName,
		std::string	graphType
	)

Constructor.

Parameters

std::string	graphTitle
std::string	graphType

Definition at line 43 of file qkd-total-graph.cc.

References Init().

Here is the call graph for this function:

◆ ~QKDTotalGraph()

ns3::QKDTotalGraph::~QKDTotalGraph ( )

virtual

Destructor.

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

Member Function Documentation

◆ GetTypeId()

TypeId ns3::QKDTotalGraph::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Init()

void ns3::QKDTotalGraph::Init	(	std::string	graphName,
		std::string	graphType
	)

Initialized function used in constructor.

Definition at line 51 of file qkd-total-graph.cc.

References ns3::Gnuplot::AppendExtra(), ns3::Gnuplot2dDataset::LINES_POINTS, m_dataset, m_datasetThreshold, m_gnuplot, m_keymCurrent, m_keymThreshold, m_plotFileName, m_plotFileType, NS_LOG_FUNCTION, ns3::GnuplotDataset::SetExtra(), ns3::Gnuplot::SetLegend(), ns3::Gnuplot::SetOutputFilename(), ns3::Gnuplot2dDataset::SetStyle(), ns3::GnuplotDataset::SetTitle(), and ns3::Gnuplot::SetTitle().

Referenced by QKDTotalGraph().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PrintGraph()

void ns3::QKDTotalGraph::PrintGraph ( )

Print the graph.

Definition at line 138 of file qkd-total-graph.cc.

References ns3::Gnuplot::AddDataset(), ns3::Gnuplot::GenerateOutput(), m_dataset, m_datasetThreshold, m_gnuplot, m_plotFileName, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ ProcessMCurrent()

void ns3::QKDTotalGraph::ProcessMCurrent	(	uint32_t	value,
		char	sign
	)

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

Parameters

uint32_t	value
char	signToBePloted

Definition at line 161 of file qkd-total-graph.cc.

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

Here is the call graph for this function:

◆ ProcessMThr()

void ns3::QKDTotalGraph::ProcessMThr	(	uint32_t	value,
		char	sign
	)

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

Parameters

uint32_t	value
char	signToBePloted

Definition at line 175 of file qkd-total-graph.cc.

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

Here is the call graph for this function:

Member Data Documentation

◆ m_dataset

Gnuplot2dDataset ns3::QKDTotalGraph::m_dataset

private

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

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

◆ m_datasetThreshold

Gnuplot2dDataset ns3::QKDTotalGraph::m_datasetThreshold

private

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

Referenced by Init(), PrintGraph(), and ProcessMThr().

◆ m_gnuplot

Gnuplot ns3::QKDTotalGraph::m_gnuplot

private

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

Referenced by Init(), and PrintGraph().

◆ m_keymCurrent

uint32_t ns3::QKDTotalGraph::m_keymCurrent

private

get some boundaries for the graph

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

Referenced by Init(), and ProcessMCurrent().

◆ m_keymThreshold

uint32_t ns3::QKDTotalGraph::m_keymThreshold

private

get some boundaries for the graph

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

Referenced by Init(), and ProcessMThr().

◆ m_plotFileName

std::string ns3::QKDTotalGraph::m_plotFileName

private

output filename

Definition at line 105 of file qkd-total-graph.h.

Referenced by Init(), and PrintGraph().

◆ m_plotFileType

std::string ns3::QKDTotalGraph::m_plotFileType

private

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

Referenced by Init().

◆ m_simulationTime

double ns3::QKDTotalGraph::m_simulationTime

private

time value, x-axis

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

Referenced by ProcessMCurrent(), and ProcessMThr().

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

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

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QKDTotalGraph() [1/2]

◆ QKDTotalGraph() [2/2]

◆ ~QKDTotalGraph()

Member Function Documentation

◆ GetTypeId()

◆ Init()

◆ PrintGraph()

◆ ProcessMCurrent()

◆ ProcessMThr()

Member Data Documentation

◆ m_dataset

◆ m_datasetThreshold

◆ m_gnuplot

◆ m_keymCurrent

◆ m_keymThreshold

◆ m_plotFileName

◆ m_plotFileType

◆ m_simulationTime