Class representing a box of rotors in the Enigma machine. More...

#include <RotorBox.hpp>

Public Member Functions
	RotorBox (ILogger *logger=nullptr)
	Constructor for the RotorBox class. Initializes the rotor box with a default number of rotors (3) and their positions (all set to 0).

	RotorBox (const std::vector< AlphabetIndex > &rotorPositions, const std::vector< RotorConfig > &rotors, const ReflectorConfig &reflector, ILogger *logger=nullptr)
	Constructor for the RotorBox class. Initializes the rotor box with a specified number of rotors, their positions, and configurations.

	RotorBox (std::vector< AlphabetIndex > &&rotorPositions, std::vector< RotorConfig > &&rotors, ReflectorConfig &&reflector, ILogger *logger=nullptr)
	Constructor for the RotorBox class (move version).

	RotorBox (const RotorBox &)=delete

RotorBox &	operator= (const RotorBox &)=delete

	RotorBox (RotorBox &&)=default

RotorBox &	operator= (RotorBox &&)=default

	~RotorBox ()=default

void	registerObserver (IEnigmaObserver *observer)
	Registers an observer to receive notifications.

void	removeObserver (IEnigmaObserver *observer)
	Removes an observer.

void	printTransformers () const
	Prints the types of transformers in the transformer vector. This function iterates through the transformer vector and prints the type of each transformer.

AlphabetIndex	keyTransform (AlphabetIndex input)
	Transforms the input key through the rotor box.

void	setLogger (ILogger *logger)
	Sets the logger for the rotor box.

Private Member Functions
void	initTransformers (const std::vector< RotorConfig > &rotors, const ReflectorConfig &reflector)
	Initializes the transformer vector with rotors and a reflector.

void	updateRotors ()
	Updates the positions of the rotors.

Private Attributes
int	rotorCount

std::vector< AlphabetIndex >	rotorPositions

std::vector< std::unique_ptr< Transformer > >	transformers

std::vector< IEnigmaObserver * >	observers

ILogger *	logger

Detailed Description

Class representing a box of rotors in the Enigma machine.

RotorBox Organization

This class manages multiple rotors and a reflector, allowing for the transformation of input keys. It handles the initialization of rotors, their positions, and the transformation process.

Definition at line 24 of file RotorBox.hpp.

Constructor & Destructor Documentation

◆ RotorBox() [1/5]

RotorBox::RotorBox ( ILogger * logger = nullptr )

explicit

Constructor for the RotorBox class. Initializes the rotor box with a default number of rotors (3) and their positions (all set to 0).

Parameters

logger Optional logger for event reporting.

Exceptions

std::runtime_error If initialization of transformers fails.

Initializes a standard 3-rotor configuration with empty/default wiring. Note: usage of this constructor is discouraged without subsequent initialization.

Definition at line 22 of file RotorBox.cpp.

References initTransformers(), rotorCount, and rotorPositions.

Here is the call graph for this function:

◆ RotorBox() [2/5]

RotorBox::RotorBox	(	const std::vector< AlphabetIndex > &	rotorPositions,
		const std::vector< RotorConfig > &	rotors,
		const ReflectorConfig &	reflector,
		ILogger *	logger = `nullptr`
	)

Constructor for the RotorBox class. Initializes the rotor box with a specified number of rotors, their positions, and configurations.

Parameters

rotorPositions	A vector containing the initial positions of each rotor.
rotors	A vector containing the configuration for each rotor.
reflector	Configuration for the reflector.
logger	Optional logger for event reporting.

Exceptions

std::invalid_argument	If the number of rotors does not match the number of positions.
std::runtime_error	If initialization of transformers fails.

Initializes a custom rotor configuration. Validates that the number of provided positions matches the rotor count before proceeding with transformer initialization and position setting.

Definition at line 35 of file RotorBox.cpp.

References initTransformers(), rotorCount, rotorPositions, and transformers.

Here is the call graph for this function:

◆ RotorBox() [3/5]

RotorBox::RotorBox	(	std::vector< AlphabetIndex > &&	rotorPositions,
		std::vector< RotorConfig > &&	rotors,
		ReflectorConfig &&	reflector,
		ILogger *	logger = `nullptr`
	)

Constructor for the RotorBox class (move version).

Parameters

rotorPositions	A vector containing the initial positions of each rotor.
rotors	A vector containing the configuration for each rotor.
reflector	Configuration for the reflector.
logger	Optional logger for event reporting.

Definition at line 52 of file RotorBox.cpp.

References rotorCount, rotorPositions, and transformers.

◆ RotorBox() [4/5]

RotorBox::RotorBox ( const RotorBox & )

delete

◆ RotorBox() [5/5]

RotorBox::RotorBox ( RotorBox && )

default

◆ ~RotorBox()

RotorBox::~RotorBox ( )

default

Member Function Documentation

◆ initTransformers()

void RotorBox::initTransformers	(	const std::vector< RotorConfig > &	rotors,
		const ReflectorConfig &	reflector
	)

private

Initializes the transformer vector with rotors and a reflector.

Parameters

rotors	A vector containing the configuration for each rotor.
reflector	Configuration for the reflector.

Populates the internal transformer vector with unique pointers to Rotor and Reflector objects.

Definition at line 85 of file RotorBox.cpp.

References rotorCount, and transformers.

Referenced by RotorBox(), and RotorBox().

Here is the caller graph for this function:

◆ keyTransform()

AlphabetIndex RotorBox::keyTransform ( AlphabetIndex input )

Transforms the input key through the rotor box.

Parameters

input The input key to be transformed.

Returns: AlphabetIndex The transformed output key.

The signal path inside the RotorBox simulates the actual wiring:

Mechanical Step: Rotate rotors BEFORE signal processing.
Forward Pass: Right-to-Left from the entry wheel through all rotors.
Reflector: Swaps the character and sends it back.
Reverse Pass: Left-to-Right back through the rotors using inverse mappings.

Definition at line 112 of file RotorBox.cpp.

References rotorCount, transformers, and updateRotors().

Here is the call graph for this function:

◆ operator=() [1/2]

RotorBox & RotorBox::operator= ( const RotorBox & )

delete

◆ operator=() [2/2]

RotorBox & RotorBox::operator= ( RotorBox && )

default

◆ printTransformers()

void RotorBox::printTransformers ( ) const

Prints the types of transformers in the transformer vector. This function iterates through the transformer vector and prints the type of each transformer.

Definition at line 95 of file RotorBox.cpp.

References logger, and transformers.

◆ registerObserver()

void RotorBox::registerObserver ( IEnigmaObserver * observer )

Registers an observer to receive notifications.

Parameters

observer The observer to register.

Definition at line 71 of file RotorBox.cpp.

References observers.

◆ removeObserver()

void RotorBox::removeObserver ( IEnigmaObserver * observer )

Removes an observer.

Parameters

observer The observer to remove.

Definition at line 73 of file RotorBox.cpp.

References observers.

◆ setLogger()

void RotorBox::setLogger ( ILogger * logger )

Sets the logger for the rotor box.

Parameters

logger The logger to use.

Definition at line 132 of file RotorBox.cpp.

References logger.

◆ updateRotors()

void RotorBox::updateRotors ( )

private

Updates the positions of the rotors.

Updates the rotor positions according to Enigma stepping mechanics.

The rightmost rotor always steps.
A rotor steps the next rotor to its left if it is at its notch position.
Double-stepping occurs when a rotor steps due to its own notch position and also causes the next rotor to step. After stepping, observers are notified of the new rotor positions.

Definition at line 142 of file RotorBox.cpp.

References logger, observers, rotorCount, and transformers.

Referenced by keyTransform().

Here is the caller graph for this function:

Member Data Documentation

◆ logger

ILogger* RotorBox::logger

private

Definition at line 30 of file RotorBox.hpp.

Referenced by printTransformers(), setLogger(), and updateRotors().

◆ observers

std::vector<IEnigmaObserver*> RotorBox::observers

private

Definition at line 29 of file RotorBox.hpp.

Referenced by registerObserver(), removeObserver(), and updateRotors().

◆ rotorCount

int RotorBox::rotorCount

private

Definition at line 26 of file RotorBox.hpp.

Referenced by RotorBox(), RotorBox(), RotorBox(), initTransformers(), keyTransform(), and updateRotors().

◆ rotorPositions

std::vector<AlphabetIndex> RotorBox::rotorPositions

private

Definition at line 27 of file RotorBox.hpp.

Referenced by RotorBox(), RotorBox(), and RotorBox().

◆ transformers

std::vector<std::unique_ptr<Transformer> > RotorBox::transformers

private

Definition at line 28 of file RotorBox.hpp.

Referenced by RotorBox(), RotorBox(), initTransformers(), keyTransform(), printTransformers(), and updateRotors().

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

RotorBox/include/RotorBox.hpp
RotorBox/src/RotorBox.cpp

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ RotorBox() [1/5]

◆ RotorBox() [2/5]

◆ RotorBox() [3/5]

◆ RotorBox() [4/5]

◆ RotorBox() [5/5]

◆ ~RotorBox()

Member Function Documentation

◆ initTransformers()

◆ keyTransform()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ printTransformers()

◆ registerObserver()

◆ removeObserver()

◆ setLogger()

◆ updateRotors()

Member Data Documentation

◆ logger

◆ observers

◆ rotorCount

◆ rotorPositions

◆ transformers