NearFieldSource

A solution aperture source.

Example

app = cf.GetApplication()
project = app:NewProject()

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

    -- Create a 'NearFieldSource' from nearFieldData

nearFieldSource = standardConfiguration.Sources:AddNearFieldSource(nearFieldData)

    --  Hide the 'NearFieldSource'

nearFieldSource.Visible = false

    -- Delete this 'NearFieldSource'

nearFieldSource:Delete()

Inheritance

The NearFieldSource object is derived from the SolutionEntity object.

Property List

BoxReferencePoint
The reference point of the definition. (Read/Write LocalCoordinates)
FieldData
The field data that defines the source references. (Read/Write FieldData)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
LocalWorkplane
The source workplane. (Read only LocalWorkplane)
Magnitude
The aperture source magnitude scaling factor. (Read/Write Expression)
Phase
The aperture source phase offset (degrees). (Read/Write Expression)
ReferencePointType
Select the reference point type. (Read/Write NearFieldDataReferencePointEnum)
Type
The object type string. (Read only string)
Visible
Specifies whether the solution entity must be shown or hidden. (Read/Write boolean)

Method List

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity. (Returns a SolutionEntity 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 table)
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

BoxReferencePoint
The reference point of the definition.
Type
LocalCoordinates
Access
Read/Write
FieldData
The field data that defines the source references.
Type
FieldData
Access
Read/Write
Included
Specifies whether the solution entity must be included or excluded.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
Read only
Magnitude
The aperture source magnitude scaling factor.
Type
Expression
Access
Read/Write
Phase
The aperture source phase offset (degrees).
Type
Expression
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 solution entity must be shown or hidden.
Type
boolean
Access
Read/Write

Method Details

Delete ()
Delete the solution entity.
Duplicate ()
Duplicate the solution entity.
Return
SolutionEntity
The 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 properties table.
SetProperties (properties table)
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(table)
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
The default properties table.