NetConfigSimulationOscillator Struct Reference

Represents an oscillator configuration for network simulation. More...

Public Types
enum class	WaveShape
	Defines the shape of the wave. More...

Public Member Functions
double	GetCurveValue (System.Random rng, double elapsedSecs)
	Calculates the value of the wave at a given time. More...

Public Attributes
double	Additional
	Additional noise to be added to the wave. More...
double	Max
	The maximum value of the wave. More...
double	Min
	The minimum value of the wave. More...
double	Period
	The period of the wave in seconds. More...
WaveShape	Shape
	The shape of the wave. More...
double	Threshold
	The threshold value for the wave. More...

Detailed Description

Represents an oscillator configuration for network simulation.

Member Enumeration Documentation

WaveShape

enum WaveShape

strong

Defines the shape of the wave.

Enumerator
Noise	Random noise wave shape.
Sine	Sine wave shape.
Square	Square wave shape.
Triangle	Triangle wave shape.
Saw	Sawtooth wave shape.
ReverseSaw	Reverse sawtooth wave shape.

Member Function Documentation

GetCurveValue()

double GetCurveValue	(	System.Random	rng,
		double	elapsedSecs
	)

Calculates the value of the wave at a given time.

Parameters

rng	The random number generator.
elapsedSecs	The elapsed time in seconds.

Returns

The calculated wave value.

Member Data Documentation

Additional

double Additional

Additional noise to be added to the wave.

Max

double Max

The maximum value of the wave.

Min

double Min

The minimum value of the wave.

Period

double Period

The period of the wave in seconds.

Shape

WaveShape Shape

The shape of the wave.

Threshold

double Threshold

The threshold value for the wave.