`NearFieldReceivingAntenna`

A solution near field receiving antenna request.

Example

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

standardConfiguration = project.Contents.SolutionConfigurations['StandardConfiguration1']
nearFieldData = project.Definitions.FieldDataList:
    AddNearFieldDataFullImportUsingKnownFileFormat([[NearFieldData.nfd]])

    -- Create a 'NearFieldReceivingAntenna' from nearFieldData

properties = cf.NearFieldReceivingAntenna.GetDefaultProperties()
properties.DefinitionType = cf.Enums.NearFieldReceivingAntennaDataTypeEnum.ReferenceEnclosedRegion
properties.FieldData = nearFieldData
nearFieldReceivingAntenna = standardConfiguration.NearFieldReceivingAntennas:Add(properties)

    --  Hide the 'NearFieldReceivingAntenna'

nearFieldReceivingAntenna.Visible = false

    -- Delete this 'NearFieldReceivingAntenna'

nearFieldReceivingAntenna:Delete()

Inheritance

The NearFieldReceivingAntenna object is derived from the BaseFieldReceivingAntenna object.

Usage locations

The NearFieldReceivingAntenna object can be accessed from the following locations:

Methods
- NearFieldReceivingAntennaCollection collection has method Add(table).
- NearFieldReceivingAntennaCollection collection has method Item(number).
- NearFieldReceivingAntennaCollection collection has method Item(string).

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)
CombinedFacesFieldData: The collection of file structure, near field data that define the faces that make up this request. (Read/Write ObjectReferenceList)
DefinitionType: Choose between the different definition typed to be used by the receiving antenna. (Read/Write NearFieldReceivingAntennaDataTypeEnum)
FieldData: The full import, aperture data that define the box that defines this request. (Read/Write NearFieldDataFullImport)
IncludeScatteredPart: Enable including only the scattered part of the field. (Read/Write boolean)
Label: The object label. (Read/Write string)
LocalWorkplane: The source workplane. (Read/Write LocalWorkplane)
ReferencePointType: Select the reference point type. (Read/Write NearFieldDataReferencePointEnum)
Type: The object type string. (Read only string)
Visible: Specifies whether the geometry must be shown or hidden. (Read/Write boolean)

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

CombinedFacesFieldData

The collection of file structure, near field data that define the faces that make up this request.

Type: ObjectReferenceList
Access: Read/Write

DefinitionType

Choose between the different definition typed to be used by the receiving antenna.

Type: NearFieldReceivingAntennaDataTypeEnum
Access: Read/Write

FieldData

The full import, aperture data that define the box that defines this request.

Type: NearFieldDataFullImport
Access: Read/Write

IncludeScatteredPart

Enable including only the scattered part of the field.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

LocalWorkplane

The source workplane.

Type: LocalWorkplane
Access: Read/Write

ReferencePointType

Select the reference point type.

Type: NearFieldDataReferencePointEnum
Access: Read/Write

Type

The object type string.

Type: string
Access: Read only

Visible

Specifies whether the geometry must be shown or hidden.

Type: boolean
Access: Read/Write

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.