NearFieldCollection
A collection of solution near fields for this solution configuration.
Example
app = cf.GetApplication() project = app:NewProject() -- Add a near field request to the near field collection configuration = project.SolutionConfigurations[1] nearFieldCollection = configuration.NearFields nearFieldRequest = nearFieldCollection:AddCartesian(0,0,0,1,1,1,3,3,3) -- Remove the near field request from the near field collection nearFieldCollection:Item(nearFieldRequest.Label):Delete()
Usage locations (collections)
The following objects contain the NearFieldCollection collection:
Property List
Method List
- Add (properties table)
- Create a near field using the table of properties. (Returns a NearField object.)
- AddCartesian (startx Expression, starty Expression, startz Expression, endx Expression, endy Expression, endz Expression, numx Expression, numy Expression, numz Expression)
- Create a near field calculation request using the Cartesian coordinate system. (Returns a NearField object.)
- AddCartesianBoundary (startx Expression, starty Expression, startz Expression, endx Expression, endy Expression, endz Expression, numx Expression, numy Expression, numz Expression)
- Create a near field calculation request using the Cartesian boundary definition method. (Returns a NearField object.)
- AddConical (startrho Expression, startphi Expression, startz Expression, endrho Expression, endphi Expression, endz Expression, numphi Expression, numz Expression)
- Create a near field calculation request using the conical coordinate system. (Returns a NearField object.)
- AddCylindrical (startrho Expression, startphi Expression, startz Expression, endrho Expression, endphi Expression, endz Expression, numrho Expression, numphi Expression, numz Expression)
- Create a near field calculation request using the cylindrical coordinate system. (Returns a NearField object.)
- AddCylindricalX (startrho Expression, startphi Expression, startx Expression, endrho Expression, endphi Expression, endx Expression, numrho Expression, numphi Expression, numx Expression)
- Create a near field calculation request using the cylindrical (X axis) coordinate system. (Returns a NearField object.)
- AddCylindricalY (startrho Expression, startphi Expression, starty Expression, endrho Expression, endphi Expression, endy Expression, numrho Expression, numphi Expression, numy Expression)
- Create a near field calculation request using the cylindrical (Y axis) coordinate system. (Returns a NearField object.)
- AddSpecifiedPoints (points List of Coordinate)
- Create a near field calculation request using specified points. (Returns a NearField object.)
- AddSpherical (startradius Expression, starttheta Expression, startphi Expression, endradius Expression, endtheta Expression, endphi Expression, numradius Expression, numtheta Expression, numphi Expression)
- Create a near field calculation request using the spherical coordinate system. (Returns a NearField object.)
- Contains (label string)
- Checks if the collection contains an item with the given label. (Returns a boolean object.)
- Item (index number)
- Returns the NearField at the given index. (Returns a NearField object.)
- Item (label string)
- Returns the NearField with the given label. (Returns a NearField object.)
- Items ()
- Returns a table of NearField. (Returns a List of NearField object.)
- UniqueName (label string)
- Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)
Index List
Property Details
Method Details
- Add (properties table)
- Create a near field using the table of properties.
- AddCartesian (startx Expression, starty Expression, startz Expression, endx Expression, endy Expression, endz Expression, numx Expression, numy Expression, numz Expression)
- Create a near field calculation request using the Cartesian coordinate system.
- Input Parameters
- startx(Expression)
- The X axis start point.
- starty(Expression)
- The Y axis start point.
- startz(Expression)
- The Z axis start point.
- endx(Expression)
- The X axis end point.
- endy(Expression)
- The Y axis end point.
- endz(Expression)
- The Z axis end point.
- numx(Expression)
- The X axis number of points.
- numy(Expression)
- The Y axis number of points.
- numz(Expression)
- The Z axis number of points.
- Return
- NearField
- The near field.
- AddCartesianBoundary (startx Expression, starty Expression, startz Expression, endx Expression, endy Expression, endz Expression, numx Expression, numy Expression, numz Expression)
- Create a near field calculation request using the Cartesian boundary definition method.
- Input Parameters
- startx(Expression)
- The X axis start point.
- starty(Expression)
- The Y axis start point.
- startz(Expression)
- The Z axis start point.
- endx(Expression)
- The X axis end point.
- endy(Expression)
- The Y axis end point.
- endz(Expression)
- The Z axis end point.
- numx(Expression)
- The X axis number of points.
- numy(Expression)
- The Y axis number of points.
- numz(Expression)
- The Z axis number of points.
- Return
- NearField
- The near field.
- AddConical (startrho Expression, startphi Expression, startz Expression, endrho Expression, endphi Expression, endz Expression, numphi Expression, numz Expression)
- Create a near field calculation request using the conical coordinate system.
- Input Parameters
- startrho(Expression)
- The Rho axis start point.
- startphi(Expression)
- The Phi axis start point (degrees).
- startz(Expression)
- The Z axis start point.
- endrho(Expression)
- The Rho axis end point.
- endphi(Expression)
- The Phi axis end point (degrees).
- endz(Expression)
- The Z axis end point.
- numphi(Expression)
- The Phi axis number of points.
- numz(Expression)
- The Z axis number of points.
- Return
- NearField
- The near field.
- AddCylindrical (startrho Expression, startphi Expression, startz Expression, endrho Expression, endphi Expression, endz Expression, numrho Expression, numphi Expression, numz Expression)
- Create a near field calculation request using the cylindrical coordinate system.
- Input Parameters
- startrho(Expression)
- The Rho axis start point.
- startphi(Expression)
- The Phi axis start point (degrees).
- startz(Expression)
- The Z axis start point.
- endrho(Expression)
- The Rho axis end point.
- endphi(Expression)
- The Phi axis end point (degrees).
- endz(Expression)
- The Z axis end point.
- numrho(Expression)
- The Rho axis number of points.
- numphi(Expression)
- The Phi axis number of points.
- numz(Expression)
- The Z axis number of points.
- Return
- NearField
- The near field.
- AddCylindricalX (startrho Expression, startphi Expression, startx Expression, endrho Expression, endphi Expression, endx Expression, numrho Expression, numphi Expression, numx Expression)
- Create a near field calculation request using the cylindrical (X axis) coordinate system.
- Input Parameters
- startrho(Expression)
- The Rho axis start point.
- startphi(Expression)
- The Phi axis start point (degrees).
- startx(Expression)
- The X axis start point.
- endrho(Expression)
- The Rho axis end point.
- endphi(Expression)
- The Phi axis end point (degrees).
- endx(Expression)
- The X axis end point.
- numrho(Expression)
- The Rho axis number of points.
- numphi(Expression)
- The Phi axis number of points.
- numx(Expression)
- The X axis number of points.
- Return
- NearField
- The near field.
- AddCylindricalY (startrho Expression, startphi Expression, starty Expression, endrho Expression, endphi Expression, endy Expression, numrho Expression, numphi Expression, numy Expression)
- Create a near field calculation request using the cylindrical (Y axis) coordinate system.
- Input Parameters
- startrho(Expression)
- The Rho axis start point.
- startphi(Expression)
- The Phi axis start point (degrees).
- starty(Expression)
- The Y axis start point.
- endrho(Expression)
- The Rho axis end point.
- endphi(Expression)
- The Phi axis end point (degrees).
- endy(Expression)
- The Y axis end point.
- numrho(Expression)
- The Rho axis number of points.
- numphi(Expression)
- The Phi axis number of points.
- numy(Expression)
- The Y axis number of points.
- Return
- NearField
- The near field.
- AddSpecifiedPoints (points List of Coordinate)
- Create a near field calculation request using specified points.
- Input Parameters
- points(List of Coordinate)
- The table of specified points.
- Return
- NearField
- The near field.
- AddSpherical (startradius Expression, starttheta Expression, startphi Expression, endradius Expression, endtheta Expression, endphi Expression, numradius Expression, numtheta Expression, numphi Expression)
- Create a near field calculation request using the spherical coordinate system.
- Input Parameters
- startradius(Expression)
- The radius start point.
- starttheta(Expression)
- The Theta axis start point (degrees).
- startphi(Expression)
- The Phi axis start point (degrees).
- endradius(Expression)
- The radius end point.
- endtheta(Expression)
- The Theta axis end point (degrees).
- endphi(Expression)
- The Phi axis end point (degrees).
- numradius(Expression)
- The radius number of points.
- numtheta(Expression)
- The Theta axis number of points.
- numphi(Expression)
- The Phi axis number of points.
- Return
- NearField
- The near field.
- Contains (label string)
- Checks if the collection contains an item with the given label.
- Item (index number)
- Returns the NearField at the given index.
- Item (label string)
- Returns the NearField with the given label.
- Items ()
- Returns a table of NearField.
- UniqueName (label string)
- Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.