FarField
A solution far field request.
Example
app = cf.GetApplication() project = app:NewProject() -- Create a far field request farFieldRequest = project.SolutionConfigurations[1].FarFields:Add(0,0,90,180,30,60)
Inheritance
The FarField object is derived from the SolutionEntity object.
Usage locations (object properties)
The following objects have properties using the FarField object:
Property List
- Advanced
- Advanced properties for the far field request. (Read only FarFieldAdvancedSettings)
- CalculationDirection
- The fields calculation direction type. (Read/Write FarFieldCalculationDirectionEnum)
- CoordinateSystem
- The fields coordinate system direction type. (Read/Write FarFieldCoordinateSystemEnum)
- Included
- Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The far field workplane. (Read only LocalWorkplane)
- Phi
- The range of phi values. (Read only RequestPointRange)
- ScopeSettings
- Far field scope settings. (Read only ScopeSettings)
- Theta
- The range of theta values. (Read only RequestPointRange)
- Type
- The object type string. (Read only string)
- U
- The range of u values. (Read only RequestPointRange)
- V
- The range of v values. (Read only RequestPointRange)
- 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
- Advanced
- Advanced properties for the far field request.
- Type
- FarFieldAdvancedSettings
- Access
- Read only
- CalculationDirection
- The fields calculation direction type.
- Type
- FarFieldCalculationDirectionEnum
- Access
- Read/Write
- The fields coordinate system direction type.
- Type
- FarFieldCoordinateSystemEnum
- 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 far field workplane.
- Type
- LocalWorkplane
- Access
- Read only
- Phi
- The range of phi values.
- Type
- RequestPointRange
- Access
- Read only
- ScopeSettings
- Far field scope settings.
- Type
- ScopeSettings
- Access
- Read only
- Theta
- The range of theta values.
- Type
- RequestPointRange
- Access
- Read only
- Type
- The object type string.
- Type
- string
- Access
- Read only
- U
- The range of u values.
- Type
- RequestPointRange
- Access
- Read only
- V
- The range of v values.
- Type
- RequestPointRange
- 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.