FarField
A solution far field request.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Create a far field request farFieldRequest = project.Contents.SolutionConfigurations[1].FarFields:Add(0,0,90,180,30,60)
Inheritance
Usage locations
The FarField object can be accessed from the following locations:
- Properties
- FarFieldOptimisationGoal object has property FocusSource.
- Methods
- FarFieldCollection collection has method Add(table).
- FarFieldCollection collection has method Add3DPattern().
- FarFieldCollection collection has method AddHorizontalCutUVPlane().
- FarFieldCollection collection has method AddRequestInPlaneWaveIncidentDirection().
- FarFieldCollection collection has method AddSquareGrid().
- FarFieldCollection collection has method AddVerticalCutUNPlane().
- FarFieldCollection collection has method AddVerticalCutVNPlane().
- FarFieldCollection collection has method Add(Expression, Expression, Expression, Expression, Expression, Expression).
- FarFieldCollection collection has method Item(number).
- FarFieldCollection collection has method Item(string).
Property List
- Advanced
- Advanced properties for the far field request. (Read/Write FarFieldAdvancedSettings)
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- CalculationDirection
- The fields calculation direction type. (Read/Write FarFieldCalculationDirectionEnum)
- CoordinateSystem
- The fields coordinate system direction type. (Read/Write FarFieldCoordinateSystemEnum)
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The source workplane. (Read/Write LocalWorkplane)
- Phi
- The range of phi values. (Read/Write PointAngleRange)
- ScopeSettings
- Far field scope settings. (Read/Write ScopeSettings)
- Theta
- The range of theta values. (Read/Write PointAngleRange)
- Type
- The object type string. (Read only string)
- U
- U. (Read/Write PointRange)
- V
- V. (Read/Write PointRange)
Collection List
- Transforms
- The collection of transforms on the operator. (TransformCollection of Transform.)
Method List
- CopyAndMirror (properties table)
- Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry. (Returns a List of Object object.)
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the geometry. (Returns a List of Object object.)
- 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
- Advanced
- Advanced properties for the far field request.
- Type
- FarFieldAdvancedSettings
- Access
- Read/Write
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- 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
- A boolean value defining if an entity is excluded or included.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The source workplane.
- Type
- LocalWorkplane
- Access
- Read/Write
- Phi
- The range of phi values.
- Type
- PointAngleRange
- Access
- Read/Write
- ScopeSettings
- Far field scope settings.
- Type
- ScopeSettings
- Access
- Read/Write
- Theta
- The range of theta values.
- Type
- PointAngleRange
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- U
- U.
- Type
- PointRange
- Access
- Read/Write
- V
- V.
- Type
- PointRange
- Access
- Read/Write
Collection Details
- Transforms
- The collection of transforms on the operator.
Method Details
- CopyAndMirror (properties table)
- Apply a copy and mirror using a table defining the properties.
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties.
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry.
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties.
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the geometry.
- 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.