`NearFieldSource`

A solution aperture source.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

nearFieldData = project.Definitions.FieldDataList:AddNearFieldDataFullImport([[NearFieldData.nfd]])

    -- Create a 'NearFieldSource' from nearFieldData

nearFieldSource = project.Contents.SolutionConfigurations.GlobalSources:AddNearFieldSource(nearFieldData)

    --  Hide the 'NearFieldSource'

nearFieldSource.Visible = false

    -- Delete this 'NearFieldSource'

nearFieldSource:Delete()

Inheritance

The NearFieldSource object is derived from the Source object.

Usage locations

The NearFieldSource object can be accessed from the following locations:

Methods
- SourceCollection collection has method AddNearFieldSource(table).
- SourceCollection collection has method AddNearFieldSource(FieldData).

Property List

BoundingBox: A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
BoxReferencePoint: The reference point of the definition. (Read/Write LocalCoordinate)
FieldData: The field data that defines the source. (Read/Write FieldData)
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)
Magnitude: The source magnitude scaling factor. (Read/Write ParametricExpression)
Phase: The source phase offset (degrees). (Read/Write ParametricExpression)
ReferencePointType: Select the reference point type. (Read/Write NearFieldDataReferencePointEnum)
Type: The object type string. (Read only string)

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

BoundingBox

A box indicating the bounding box of this entity. (Read only Box).

Type: Box
Access: Read only

BoxReferencePoint

The reference point of the definition.

Type: LocalCoordinate
Access: Read/Write

FieldData

The field data that defines the source.

Type: FieldData
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

Magnitude

The source magnitude scaling factor.

Type: ParametricExpression
Access: Read/Write

Phase

The source phase offset (degrees).

Type: ParametricExpression
Access: Read/Write

ReferencePointType

Select the reference point type.

Type: NearFieldDataReferencePointEnum
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Collection Details

Transforms

The collection of transforms on the operator.

Type: TransformCollection

Method Details

CopyAndMirror (properties table)

Apply a copy and mirror using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the mirror transform.

Return

Object: The mirrored geometry.

CopyAndRotate (properties table, count number)

Apply a copy and rotate using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the rotate transform.
count(number): The number of transform copies.

Return

List of Object: The list of rotated geometry.

CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)

Copy and rotate the geometry.

Input Parameters

origin(Point): The coordinates of the origin of the rotation.
rotationaxis(Vector): The axis of rotation.
angle(number): The angle of rotation (degrees).
count(number): The number of copies.

Return

List of Object: The list of rotated geometry.

CopyAndTranslate (properties table, count number)

Apply a copy and translate using a table defining the properties.

Input Parameters

properties(table): A table of properties defining the translate transform.
count(number): The number of transform copies.

Return

List of Object: The list of translated geometry.

CopyAndTranslate (from Point, to Point, count number)

Copy and translate the geometry.

Input Parameters

from(Point): Translate from coordinate.
to(Point): Translate to coordinate.
count(number): The number of copies.

Return

List of Object: The list of translated 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.