CLASS_REFERENCE.md

Documentation des Classes

Table des Matières

• RailwaySignal
• SignalCommand
• SignalState
• StateValidator
• SafetyTimer

RailwaySignal

RailwaySignal est la classe principale qui gère l'état et le comportement d'un signal ferroviaire.

Énumérations

enum class Aspect {
    RED,    ///< Signal fermé
    GREEN,  ///< Signal ouvert
    YELLOW  ///< Signal à vitesse limitée
}

Constructeur

explicit RailwaySignal(const std::string& id)

• Paramètres
  • id: Identifiant unique du signal
• Description: Initialise un nouveau signal avec l'état initial RED (sûr).

Méthodes Publiques

setAspect

std::expected<void, std::string> setAspect(Aspect aspect)

• Paramètres
  • aspect: Nouvel aspect à appliquer
• Retour: std::expected contenant succès ou message d'erreur
• Safety Level: SIL4
• Description: Change l'aspect du signal après validation des règles de sécurité.

getAspect

Aspect getAspect() const

• Retour: L'aspect actuel du signal
• Safety Level: SIL4
• Description: Retourne l'état actuel du signal.

executeCommand

void executeCommand(std::unique_ptr<SignalCommand> command)

• Paramètres
  • command: Commande à exécuter
• Safety Level: SIL4
• Description: Exécute une commande et l'ajoute à l'historique.

undoLastCommand/redoCommand

void undoLastCommand()
void redoCommand()

• Safety Level: SIL4
• Description: Gère l'annulation et la réexécution des commandes.

Signaux

boost::signals2::signal<void(Aspect)> aspectChanged

• Description: Notifie les observateurs des changements d'aspect.

SignalCommand

Interface abstraite pour le pattern Command.

Méthodes Virtuelles

virtual void execute() = 0
virtual void undo() = 0

Classes Dérivées

ChangeAspectCommand

class ChangeAspectCommand : public SignalCommand

• Description: Implémente une commande de changement d'aspect.
• Safety Level: SIL4

SignalState

Interface abstraite pour le pattern State.

Méthodes Virtuelles

virtual void update() = 0
virtual bool canTransitionTo(Aspect aspect) = 0

Classes Dérivées

RedState

• Transitions Autorisées: Vers YELLOW uniquement
• Safety Level: SIL4

YellowState

• Transitions Autorisées: Vers RED ou GREEN
• Safety Level: SIL4

GreenState

• Transitions Autorisées: Vers YELLOW ou RED (urgence)
• Safety Level: SIL4

StateValidator

Classe utilitaire pour la validation des transitions.

Méthodes Statiques

static bool validateTransition(Aspect from, Aspect to)

• Description: Valide les transitions selon la matrice de sécurité.
• Safety Level: SIL4

SafetyTimer

Classe utilitaire pour la gestion des timeouts de sécurité.

Constructeur

explicit SafetyTimer(std::chrono::milliseconds timeout)

Méthodes

bool hasExpired() const
void reset()

Diagrammes de Classes

classDiagram
    class RailwaySignal {
        -string id_
        -Aspect currentAspect_
        -vector~unique_ptr~SignalCommand~~ commandHistory_
        +setAspect(Aspect) std::expected~void,string~
        +getAspect() Aspect
        +executeCommand(unique_ptr~SignalCommand~)
        +undoLastCommand()
        +redoCommand()
    }

    class SignalCommand {
        <<interface>>
        +execute()*
        +undo()*
    }

    class SignalState {
        <<interface>>
        +update()*
        +canTransitionTo(Aspect)*
    }

    RailwaySignal --> SignalState
    RailwaySignal --> SignalCommand
    ChangeAspectCommand --|> SignalCommand
    RedState --|> SignalState
    YellowState --|> SignalState
    GreenState --|> SignalState

Loading