SineSignal Class

Api Class for creating and updating Sine Signals

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseSineSignal
    ema3d.Api.V25.Core.SignalsAnalyticSignalBaseSineSignal, SineWaveform
      ema3d.Api.V25.Core.SignalsSineSignal

Namespace: ema3d.Api.V25.Core.Signals
Assembly: ema3d.Api.V25 (in ema3d.Api.V25.dll) Version: 0.0.0.0

Syntax

C++

Copy

public sealed class SineSignal : AnalyticSignalBase<SineSignal, SineWaveform>

Public NotInheritable Class SineSignal
	Inherits AnalyticSignalBase(Of SineSignal, SineWaveform)

public ref class SineSignal sealed : public AnalyticSignalBase<SineSignal^, SineWaveform^>

[<SealedAttribute>]
type SineSignal = 
    class
        inherit AnalyticSignalBase<SineSignal, SineWaveform>
    end

The SineSignal type exposes the following members.

Properties

	Name	Description
	Amplitude	Gets/Sets amplitude of Sine squared waveform
	AShift	Gets / Sets amplitude shift (up/down)
	DisplayName	Gets/Sets the display name of the underlying sim object. (Inherited from APISimObjectBaseTWrapper)
	Frequency	Gets / Sets frequency in of Sine squared waveform in Hz
	Name	Name of the Analytic Signal (Inherited from AnalyticSignalBaseTWrapper, TWave)
	TEnd	The simulation time the signal turns off. The default end time matches the simulation end time (Inherited from AnalyticSignalBaseTWrapper, TWave)
	TShift	Gets / sets time shift (left/right)
	TStart	The simulation time the signal turns on. The default start time matches the simulation start time. (Inherited from AnalyticSignalBaseTWrapper, TWave)
	TStep	The sample rate of the signal. The default step time matches the simulation step time. (Inherited from AnalyticSignalBaseTWrapper, TWave)

Top

Methods

	Name	Description
	AttachTo	Attaches the signal to the Wave (Inherited from AnalyticSignalBaseTWrapper, TWave)
	Create	Create a Sine Signal
	Delete	Delete the Analytic Signal (Inherited from AnalyticSignalBaseTWrapper, TWave)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAll	Retrieve all SineSignal objects in the document.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetName	Returns the name of the object. (Inherited from APISimObjectBaseTWrapper)
	GetSiblings	Get all objects that share this object's type in the document. (Overrides APISimObjectBaseTWrapperGetSiblings(Document))
	GetType	Gets the Type of the current instance. (Inherited from Object)
	SetName	Sets the name of the object (Inherited from APISimObjectBaseTWrapper)
	SetVisibility	Sets the visibility status of the object. (Inherited from APISimObjectBaseTWrapper)
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Example

Python

Copy

from ema3d.Api.V25.Core.Signals import SineSignal as SineSignal
# Create the signal
_sine = SineSignal.Create()
_sine.DisplayName = "SineSignal"
_sine.Amplitude = 80
_sine.Frequency = 8e6

Reference

ema3d.Api.V25.Core.Signals Namespace