FarFieldSource
A solution far field source.
Example
app = cf.GetApplication() project = app:NewProject() standardConfiguration = project.SolutionConfigurations['StandardConfiguration1'] farFieldData = project.FieldDataList:AddFarFieldData([[FarFieldData.ffe]]) -- Create a 'FarFieldSource' from farFieldData farFieldSource = standardConfiguration.Sources:AddFarFieldSource(farFieldData) -- Set the phase of the NearFieldSource to 30 degrees farFieldSource.Phase = 30 -- Delete this FarFieldSource farFieldSource:Delete()
Inheritance
The FarFieldSource object is derived from the SolutionEntity object.
Property List
- FieldData
- The field data that defines the far field source. (Read/Write FieldData)
- Included
- Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The source workplane. (Read only LocalWorkplane)
- Magnitude
- The far field source magnitude scaling factor. (Read/Write Expression)
- Phase
- The far field source phase offset (degrees). (Read/Write Expression)
- Phi
- The far field source Phi orientation (degrees). (Read/Write Expression)
- Position
- The position of the source. (Read/Write LocalCoordinates)
- Theta
- The far field source Theta orientation (degrees). (Read/Write Expression)
- Type
- The object type string. (Read only string)
- Visible
- Specifies whether the solution entity must be shown or hidden. (Read/Write boolean)
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
- FieldData
- The field data that defines the far field source.
- Type
- FieldData
- Access
- Read/Write
- 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
- LocalWorkplane
- The source workplane.
- Type
- LocalWorkplane
- Access
- Read only
- Magnitude
- The far field source magnitude scaling factor.
- Type
- Expression
- Access
- Read/Write
- Phase
- The far field source phase offset (degrees).
- Type
- Expression
- Access
- Read/Write
- Phi
- The far field source Phi orientation (degrees).
- Type
- Expression
- Access
- Read/Write
- Position
- The position of the source.
- Type
- LocalCoordinates
- Access
- Read/Write
- Theta
- The far field source Theta orientation (degrees).
- Type
- Expression
- 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
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.