# WaveguidePort

A waveguide port is used to define a plane of excitation for a waveguide structure.

## Example

local application = cf.Application.GetInstance()
local project = application:NewProject()

-- Create a hollow cuboid

corner = cf.Point(-0.25, -0.25, 0)
cube = project.Contents.Geometry:AddCuboid(corner, 0.5, 0.5, 1.25)
project.Contents.Geometry[1].Regions[1].Medium = project.Definitions.Media.FreeSpace

-- Create a waveguide port on the cube

port = project.Contents.Ports:AddWaveguidePort(cube.Faces[1])

## Inheritance

The WaveguidePort object is derived from the Port object.

## Usage locations

The WaveguidePort object can be accessed from the following locations:

## Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
DirectionReversed
The option to set the propagation direction opposite to the normal direction. (Read/Write boolean)
Face
The face to which the waveguide port is applied. (Read/Write Face)
Label
ManualReferenceVector
The components for the reference vector. The reference vector must be set manually for property to take effect.This is only valid if ManualReferenceVectorEnabled is true. (Read/Write GlobalCoordinates)
ManualReferenceVectorEnabled
The option to specify the reference direction manually. (Read/Write boolean)
MaxModalExpansionEnabled
The option to specify the maximum modal expansion indices manually. (Read/Write boolean)
MaxModalExpansionIndexM
The option to specify the maximum modal expansion index m manually. This is only valid if MaxModalExpansionEnabled is true. (Read/Write ParametricExpression)
MaxModalExpansionIndexN
The option to specify the maximum modal expansion index n manually. This is only valid if MaxModalExpansionEnabled is true. (Read/Write ParametricExpression)
ReferenceDirectionRotation
The reference direction rotation. This is only valid if ManualReferenceVectorEnabled is false. (Read/Write WaveguidePortReferenceDirectionRotationEnum)
ReferenceVector
The components for the reference vector. The reference vector must be set manually for property to take effect.This is only valid if ManualReferenceVectorEnabled is true. (Read only Vector)
Type
The object type string. (Read only string)
Visible
Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

## 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
DirectionReversed
The option to set the propagation direction opposite to the normal direction.
Type
boolean
Access
Face
The face to which the waveguide port is applied.
Type
Face
Access
Label
The object label.
Type
string
Access
ManualReferenceVector
The components for the reference vector. The reference vector must be set manually for property to take effect.This is only valid if ManualReferenceVectorEnabled is true.
Type
GlobalCoordinates
Access
ManualReferenceVectorEnabled
The option to specify the reference direction manually.
Type
boolean
Access
MaxModalExpansionEnabled
The option to specify the maximum modal expansion indices manually.
Type
boolean
Access
MaxModalExpansionIndexM
The option to specify the maximum modal expansion index m manually. This is only valid if MaxModalExpansionEnabled is true.
Type
ParametricExpression
Access
MaxModalExpansionIndexN
The option to specify the maximum modal expansion index n manually. This is only valid if MaxModalExpansionEnabled is true.
Type
ParametricExpression
Access
ReferenceDirectionRotation
The reference direction rotation. This is only valid if ManualReferenceVectorEnabled is false.
Type
WaveguidePortReferenceDirectionRotationEnum
Access
ReferenceVector
The components for the reference vector. The reference vector must be set manually for property to take effect.This is only valid if ManualReferenceVectorEnabled is true.
Type
Vector
Access
Type
The object type string.
Type
string
Access
Visible
Specifies whether the geometry must be shown or hidden.
Type
boolean
Access

## 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.