SpecifiedRequestPointsCollection
A collection of request points coordinates.
Example
app = cf.GetApplication() project = app:NewProject() -- Add a NearField by specifying a table of arbitrary points points = {} points[1] = cf.Point(0.3,0.1,0.0) points[2] = cf.Point(0.3,0.7,0.0) points[3] = cf.Point(0.7,0.7,0.0) nearField = project.SolutionConfigurations[1].NearFields:AddSpecifiedPoints(points) -- Modify the N coordinate of the last NearField point numberOfPoint = #nearField.SpecifiedRequestPoints.Points nearField.SpecifiedRequestPoints.Points[numberOfPoint].N = 2.0
Usage locations (collections)
The following objects contain the SpecifiedRequestPointsCollection collection:
Property List
Method List
- Add (point Coordinate)
- Add a specific request point to the near field. This method is only valid when the DefinitionMethod is SpecifiedPoints.
- Item (index number)
- Returns the LocalCoordinates at the given index. (Returns a LocalCoordinates object.)
- Modify (index number, point Coordinate)
- Modify the request point of the specified points at the given index. This method is only valid when the DefinitionMethod is SpecifiedPoints.
- Remove (index number)
- Remove point from the specified points at the given index. This method is only valid when the DefinitionMethod is SpecifiedPoints.
- Set (points List of Point)
- Replace the request points with a list of points.
Index List
- [number]
- Returns the LocalCoordinates at the given index in the collection. (Read LocalCoordinates)
Property Details
- Count
- The number of LocalCoordinates items in the collection.
- Type
- number
- Access
- Read only
Method Details
- Add (point Coordinate)
- Add a specific request point to the near field. This method is only valid when the DefinitionMethod is SpecifiedPoints.
- Input Parameters
- point(Coordinate)
- The request point.
- Item (index number)
- Returns the LocalCoordinates at the given index.
- Input Parameters
- index(number)
- The index of the LocalCoordinates.
- Return
- LocalCoordinates
- The LocalCoordinates at the given index.
- Modify (index number, point Coordinate)
- Modify the request point of the specified points at the given index. This method is only valid when the DefinitionMethod is SpecifiedPoints.
- Input Parameters
- index(number)
- The request point index.
- point(Coordinate)
- The request point.
- Remove (index number)
- Remove point from the specified points at the given index. This method is only valid when the DefinitionMethod is SpecifiedPoints.
- Input Parameters
- index(number)
- The request point index.
- Set (points List of Point)
- Replace the request points with a list of points.