Class astrea::astro::Event

ClassList > astrea > astro > Event

A class representing a Event in the astrea astro platform. This class serves as a base for user-defined Events and provides a common interface.

• #include <Event.hpp>

Public Functions

Type	Name
	Event () Default constructor for Event .
	Event (const Event & other) Copy constructor for Event .
	Event (Event && other) noexcept Move constructor for Event .
void *	get_ptr () Gets a pointer to the internal Event instance.
Event &	operator= (Event && other) noexcept Copy assignment operator for Event .
Event &	operator= (const Event & other) Move assignment operator for Event .
	requires (IsGenericallyConstructableEvent< T >) Constructs a Event with a user-defined type.
	requires (IsGenericallyConstructableEvent< T >) Generic assignment operator for Event .

Public Functions Documentation

function Event [1/3]

Default constructor for Event .

astrea::astro::Event::Event () 

---

function Event [2/3]

Copy constructor for Event .

astrea::astro::Event::Event (
    const Event & other
) 

Parameters:

• other The Event instance to copy from.

---

function Event [3/3]

Move constructor for Event .

astrea::astro::Event::Event (
    Event && other
) noexcept

Parameters:

• other The Event instance to move from.

---

function get_ptr

Gets a pointer to the internal Event instance.

void * astrea::astro::Event::get_ptr () 

Returns:

void* A pointer to the internal Event instance.

---

function operator=

Copy assignment operator for Event .

Event & astrea::astro::Event::operator= (
    Event && other
) noexcept

Returns:

Event& A reference to the current Event instance.

---

function operator=

Move assignment operator for Event .

Event & astrea::astro::Event::operator= (
    const Event & other
) 

Parameters:

• other The Event instance to move from.

Returns:

Event& A reference to the current Event instance.

---

function requires [1/2]

Constructs a Event with a user-defined type.

template<typename T>
inline astrea::astro::Event::requires (
    IsGenericallyConstructableEvent< T >
) 

Template parameters:

• T The type of the user-defined Event.

Parameters:

• x The user-defined Event instance to initialize the Event.

---

function requires [2/2]

Generic assignment operator for Event .

template<typename T>
astrea::astro::Event::requires (
    IsGenericallyConstructableEvent< T >
) 

Template parameters:

• T The type of the user-defined Event.

Parameters:

• x The user-defined Event instance to assign to the Event.

Returns:

Event& A reference to the current Event instance.

---

---

The documentation for this class was generated from the following file astrea/astro/astro/propagation/event_detection/Event.hpp