AntennaSource Class

Antenna source API class

Inheritance Hierarchy

SystemObject
  ema3d.Api.V25APISimObjectBaseAntennaSource
    ema3d.Api.V25.Core.ExcitationExcitationBaseAntennaSource
      ema3d.Api.V25.Core.ExcitationAntennaSource

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

Syntax

C++

Copy

public sealed class AntennaSource : ExcitationBase<AntennaSource>

Public NotInheritable Class AntennaSource
	Inherits ExcitationBase(Of AntennaSource)

public ref class AntennaSource sealed : public ExcitationBase<AntennaSource^>

[<SealedAttribute>]
type AntennaSource = 
    class
        inherit ExcitationBase<AntennaSource>
    end

The AntennaSource type exposes the following members.

Properties

	Name	Description
	DisplayName	Antenna Source display name. (Overrides APISimObjectBaseTWrapperDisplayName)
	Document	The document an object exists in. (Inherited from ExcitationBaseT)
	End	Gets end location of excitated region (0-length)
	ExcitedPosition	Gets/Sets excited segment location.
	ExcitedSegment	Gets excited segment
	Inductance	Gets/Sets inductance of antenna (S / m)
	PortImpedance	Gets/Sets the port impedance of antenna (ohms)
	Radius	Gets/Sets radius of the antenna.
	Resistance	Gets/Sets resistance of antenna (Ohm / m)
	Segments	Gets/Sets segments defining the antenna's geometry.
	SeriesBC	Gets/Sets if pin voltage is in series with circuit boundary.
	Simulation	The Simulation an object exists in. (Inherited from ExcitationBaseT)
	SourceGeometry	Gets/Sets allowable location for excitation node
	SourceType	Gets/Sets type of antenna source.
	Start	Get starts location of excited location (0-length)

Top

Methods

	Name	Description
	Create	Gets the antenna source instance in a document or creates one if it does not exist.
	Delete	Deletes sim object. (Inherited from APISimObjectBaseTWrapper)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetAll	Retrieve all AntennaSource objects in the document.
	GetByDisplayName	Get AntennaSource by display name
	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.Excitation import AntennaSource as AntennaSource
from ema3d.Api.V25.Cabling import SegmentLocation as SegmentLocation

# Set Sketch Plane
result = ViewHelper.SetSketchPlane(Plane.PlaneXY)
# Sketch Rectangle
point1 = Point2D.Create(MM(-10),MM(-10))
point2 = Point2D.Create(MM(10),MM(-10))
result = SketchLine.Create(point1, point2)
# Solidify Sketch
ViewHelper.SetViewMode(InteractionMode.Solid)
resCurve = result.CreatedCurves[0]

# Set Thin Gap
resLoc = SegmentLocation(resCurve, 0.0)
antsource = AntennaSource.Create({resCurve},
                                 resLoc,
                                 Window.ActiveWindow.Document)
antsource.DisplayName = "Test Antenna Source"
antsource.Radius = 3e-3

Reference

ema3d.Api.V25.Core.Excitation Namespace