NearFieldReceivingAntenna
A solution near field receiving antenna request.
Example
app = cf.GetApplication() project = app:NewProject() standardConfiguration = project.SolutionConfigurations['StandardConfiguration1'] nearFieldData = project.FieldDataList: AddNearFieldDataFullImport([[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 SolutionEntity object.
Property List
- BoxReferencePoint
- The reference point of the definition. (Read/Write LocalCoordinates)
- CombinedFacesFieldData
- The collection of file structure, near field data that define the faces that make up this request. (Read/Write List of FieldData)
- 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 FieldData)
- IncludeScatteredPart
- True if scattered parts are included. (Read/Write boolean)
- 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)
- 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
- CombinedFacesFieldData
- The collection of file structure, near field data that define the faces that make up this request.
- 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
- FieldData
- Access
- Read/Write
- IncludeScatteredPart
- True if scattered parts are included.
- Type
- boolean
- 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
- 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.