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

QKDEncryptorManager. More...

#include "qkd-encryptor-manager.h"

+ Inheritance diagram for ns3::QKDEncryptorManager:
+ Collaboration diagram for ns3::QKDEncryptorManager:

Public Member Functions

 QKDEncryptorManager ()
 Constructor. More...
 
virtual ~QKDEncryptorManager ()
 Destructor. More...
 
uint32_t AddQKDEncryptor (Ptr< QKDEncryptor > device)
 Associate a QKDEncryptor to this node. More...
 
uint32_t GetNQKDEncryptors (void) const
 Get a number of the associated QKDEncryptors. More...
 
Ptr< QKDEncryptorGetQKDEncryptor (uint32_t index) const
 Retrieve the index-th QKDEncryptor associated to this node. 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<>
Ptr< ObjectGetObject () 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< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. 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[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= ([[maybe_unused]] 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

std::vector< Ptr< QKDEncryptor > > m_qkdencryptors
 QKDEncryptors associated to this node. 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

QKDEncryptorManager.

Introspection did not find any typical Config paths.

QKDEncryptorManager is a class used to manage multiple encryptors on a single node

Note
@toDo: implement functionalities


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

Definition at line 46 of file qkd-encryptor-manager.h.

Constructor & Destructor Documentation

◆ QKDEncryptorManager()

ns3::QKDEncryptorManager::QKDEncryptorManager ( )

Constructor.

Definition at line 37 of file qkd-encryptor-manager.cc.

References NS_LOG_FUNCTION.

◆ ~QKDEncryptorManager()

ns3::QKDEncryptorManager::~QKDEncryptorManager ( )
virtual

Destructor.

Definition at line 42 of file qkd-encryptor-manager.cc.

Member Function Documentation

◆ AddQKDEncryptor()

uint32_t ns3::QKDEncryptorManager::AddQKDEncryptor ( Ptr< QKDEncryptor device)

Associate a QKDEncryptor to this node.

Parameters
deviceThe QKDEncryptor to associate to this node.
Returns
The index of the QKDEncryptor into the Node's list of QKDEncryptor.

Definition at line 46 of file qkd-encryptor-manager.cc.

References m_qkdencryptors, and NS_LOG_FUNCTION.

◆ GetNQKDEncryptors()

uint32_t ns3::QKDEncryptorManager::GetNQKDEncryptors ( void  ) const

Get a number of the associated QKDEncryptors.

Returns
The number of QKDEncryptor instances associated to this Node.

Definition at line 64 of file qkd-encryptor-manager.cc.

References m_qkdencryptors, and NS_LOG_FUNCTION.

◆ GetQKDEncryptor()

Ptr< QKDEncryptor > ns3::QKDEncryptorManager::GetQKDEncryptor ( uint32_t  index) const

Retrieve the index-th QKDEncryptor associated to this node.

Parameters
indexThe index of the requested QKDEncryptor
Returns
The requested QKDEncryptor.

Definition at line 56 of file qkd-encryptor-manager.cc.

References m_qkdencryptors, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ GetTypeId()

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

Get the type ID.

Returns
the object TypeId

Definition at line 29 of file qkd-encryptor-manager.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_qkdencryptors

std::vector<Ptr<QKDEncryptor> > ns3::QKDEncryptorManager::m_qkdencryptors
private

QKDEncryptors associated to this node.

Definition at line 93 of file qkd-encryptor-manager.h.

Referenced by AddQKDEncryptor(), GetNQKDEncryptors(), and GetQKDEncryptor().


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