NearField

A solution near field request.

Example

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

    -- Create a near field request
    
nearFieldRequest = project.SolutionConfigurations[1].NearFields:AddCartesian(0,0,0,1,1,1,3,3,3)

Inheritance

The NearField object is derived from the SolutionEntity object.

Usage locations (object properties)

The following objects have properties using the NearField object:

Property List

Advanced
Advanced properties for the near field request. (Read only NearFieldAdvancedSettings)
BoundarySurface
The near field Cartesian boundary surface settings. Only valid if DefinitionMethod is CartesianBoundary. (Read only NearFieldBoundarySurface)
CartesianRequestPoints
The near field Cartesian request points. Only valid if DefinitionMethod is Cartesian or CartesianBoundary. (Read only CartesianRequestPoints)
ConicalRequestPoints
The near field Conical request points. Only valid if DefinitionMethod is Conical. (Read only ConicalRequestPoints)
CylindricalRequestPoints
The near field Cylindrical request points. Only valid if DefinitionMethod is Cylindrical. (Read only CylindricalRequestPoints)
CylindricalXRequestPoints
The near field Cylindrical (X axis) request points. Only valid if DefinitionMethod is CylindricalX. (Read only CylindricalXRequestPoints)
CylindricalYRequestPoints
The near field Cylindrical (Y axis) request points. Only valid if DefinitionMethod is CylindricalY. (Read only CylindricalYRequestPoints)
DefinitionMethod
The definition method/coordinate system. (Read/Write NearFieldDefinitionMethodEnum)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
LocalWorkplane
The near field workplane. (Read only LocalWorkplane)
PointSpecificationMethod
The point specification method. (Read/Write NearFieldPointSpecificationTypeEnum)
SampleOnEdgesEnabled
Activates sampling on edges. (Read/Write boolean)
ScopeSettings
Near field scope settings. (Read only ScopeSettings)
SpecifiedRequestPoints
The near field group for Specified request points. Only valid if DefinitionMethod is SpecifiedPoints. (Read only SpecifiedRequestPoints)
SphericalRequestPoints
The near field Spherical request points. Only valid if DefinitionMethod is Spherical. (Read only SphericalRequestPoints)
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.)
GetRequestPointsAsCartesian ()
Get the Cartesian equivalent coordinates in a case where other coordinate systems are used. (Returns a List of Point 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

Advanced
Advanced properties for the near field request.
Type
NearFieldAdvancedSettings
Access
Read only
BoundarySurface
The near field Cartesian boundary surface settings. Only valid if DefinitionMethod is CartesianBoundary.
Type
NearFieldBoundarySurface
Access
Read only
CartesianRequestPoints
The near field Cartesian request points. Only valid if DefinitionMethod is Cartesian or CartesianBoundary.
Type
CartesianRequestPoints
Access
Read only
ConicalRequestPoints
The near field Conical request points. Only valid if DefinitionMethod is Conical.
Type
ConicalRequestPoints
Access
Read only
CylindricalRequestPoints
The near field Cylindrical request points. Only valid if DefinitionMethod is Cylindrical.
Type
CylindricalRequestPoints
Access
Read only
CylindricalXRequestPoints
The near field Cylindrical (X axis) request points. Only valid if DefinitionMethod is CylindricalX.
Type
CylindricalXRequestPoints
Access
Read only
CylindricalYRequestPoints
The near field Cylindrical (Y axis) request points. Only valid if DefinitionMethod is CylindricalY.
Type
CylindricalYRequestPoints
Access
Read only
DefinitionMethod
The definition method/coordinate system.
Type
NearFieldDefinitionMethodEnum
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 near field workplane.
Type
LocalWorkplane
Access
Read only
PointSpecificationMethod
The point specification method.
Type
NearFieldPointSpecificationTypeEnum
Access
Read/Write
SampleOnEdgesEnabled
Activates sampling on edges.
Type
boolean
Access
Read/Write
ScopeSettings
Near field scope settings.
Type
ScopeSettings
Access
Read only
SpecifiedRequestPoints
The near field group for Specified request points. Only valid if DefinitionMethod is SpecifiedPoints.
Type
SpecifiedRequestPoints
Access
Read only
SphericalRequestPoints
The near field Spherical request points. Only valid if DefinitionMethod is Spherical.
Type
SphericalRequestPoints
Access
Read only
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.
GetRequestPointsAsCartesian ()
Get the Cartesian equivalent coordinates in a case where other coordinate systems are used.
Return
List of Point
The application project.
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.