WaveguideSource

A waveguide source.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Create a waveguide port

cuboid = project.Geometry:AddCuboid(cf.Point(-1,1,0), 1, 1, 1)
cuboid.Regions[1].Medium = project.Media:GetFreeSpace()

waveguidePort = project.Ports:AddWaveguidePort(cuboid.Faces[1])

    -- Add a waveguide source to the waveguide port

configuration = project.SolutionConfigurations[1]
source = configuration.Sources:AddWaveguideSource(waveguidePort)

Inheritance

The WaveguideSource object is derived from the SolutionEntity object.

Property List

FundamentalModeOptions
The fundamental mode options. Only valid if SourceDefinitionType is ExciteFundamentalModeOnly. (Read only FundamentalModeOptions)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
SourceDefinitionType
The waveguide source method. (Read/Write WaveguideSourceDefinitionTypeEnum)
Terminal
The port terminal connected to the waveguide source. (Read/Write TerminalType)
Type
The object type string. (Read only string)
Visible
Specifies whether the solution entity must be shown or hidden. (Read/Write boolean)

Collection List

ManuallySpecifiedModesProperties
The collection of waveguide mode properties. Only valid if SourceDefinitionType is SpecifyModesManually. (WaveguideModeOptionsCollection of WaveguideModeOptions.)

Method List

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity. (Returns a SolutionEntity object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

FundamentalModeOptions
The fundamental mode options. Only valid if SourceDefinitionType is ExciteFundamentalModeOnly.
Type
FundamentalModeOptions
Access
Read only
Included
Specifies whether the solution entity must be included or excluded.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
SourceDefinitionType
The waveguide source method.
Type
WaveguideSourceDefinitionTypeEnum
Access
Read/Write
Terminal
The port terminal connected to the waveguide source.
Type
TerminalType
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Visible
Specifies whether the solution entity must be shown or hidden.
Type
boolean
Access
Read/Write

Collection Details

ManuallySpecifiedModesProperties
The collection of waveguide mode properties. Only valid if SourceDefinitionType is SpecifyModesManually.
Type
WaveguideModeOptionsCollection

Method Details

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity.
Return
SolutionEntity
The duplicated entity.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A properties table.
SetProperties (properties table)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(table)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
The default properties table.