WaveguideSource
A waveguide source.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Create a waveguide port cuboid = project.Contents.Geometry:AddCuboid(cf.Point(-1,1,0), 1, 1, 1) cuboid.Regions[1].Medium = project.Definitions.Media.FreeSpace waveguidePort = project.Contents.Ports:AddWaveguidePort(cuboid.Faces[1]) -- Add a waveguide source to the waveguide port source = project.Contents.SolutionConfigurations.GlobalSources:AddWaveguideSource(waveguidePort)
Inheritance
The WaveguideSource object is derived from the Source object.
Usage locations
The WaveguideSource object can be accessed from the following locations:
- Methods
- SourceCollection collection has method AddWaveguideSource(table).
- SourceCollection collection has method AddWaveguideSource(WaveguidePort).
Property List
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- FundamentalModeOptions
- The fundamental mode options. Only valid if SourceDefinitionType is ExciteFundamentalModeOnly. (Read/Write FundamentalModeOptions)
- Label
- The object label. (Read/Write string)
- Magnitude
- The source magnitude. (Read/Write ParametricExpression)
- ManuallySpecifiedModesProperties
- The collection of waveguide mode properties. Only valid if SourceDefinitionType is SpecifyModesManually. (Read/Write WaveguideModeOptionsList)
- Phase
- The source phase (degrees). (Read/Write ParametricExpression)
- SourceDefinitionType
- The waveguide source method. (Read/Write WaveguideSourceDefinitionTypeEnum)
- Type
- The object type string. (Read only string)
Method List
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity. (Returns a Object 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 Object)
- 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
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- FundamentalModeOptions
- The fundamental mode options. Only valid if SourceDefinitionType is ExciteFundamentalModeOnly.
- Type
- FundamentalModeOptions
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Magnitude
- The source magnitude.
- Type
- ParametricExpression
- Access
- Read/Write
- ManuallySpecifiedModesProperties
- The collection of waveguide mode properties. Only valid if SourceDefinitionType is SpecifyModesManually.
- Type
- WaveguideModeOptionsList
- Access
- Read/Write
- Phase
- The source phase (degrees).
- Type
- ParametricExpression
- Access
- Read/Write
- SourceDefinitionType
- The waveguide source method.
- Type
- WaveguideSourceDefinitionTypeEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
Method Details
- Delete ()
- Deletes the entity.
- Duplicate ()
- Duplicates the entity.
- Return
- Object
- The new (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 table defining the properties.
- SetProperties (properties Object)
- 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(Object)
- 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
- A table containing the default properties.