FarFieldData
A far field data using file structure import.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Import 'FarFieldData' from previously a exported 'FarField' farFieldData = project.Definitions.FieldDataList:AddFarFieldDataUsingKnownFileFormat([[FarFieldData.ffe]])
Inheritance
The FarFieldData object is derived from the FieldData object.
Usage locations
The FarFieldData object can be accessed from the following locations:
- Properties
- FarFieldReceivingAntenna object has property FieldData.
- Methods
- FieldDataCollection collection has method AddFarFieldData(table).
- FieldDataCollection collection has method AddFarFieldDataUsingKnownFileFormat(string).
- FieldDataCollection collection has method AddFarFieldDataUsingStructure(string, Expression, Expression).
Property List
- DataBlockNumber
- The data block that is first read from. (Read/Write ParametricExpression)
- FieldDataFileImportDefinitionTypeEnum
- The definition type used to import the file. (Read/Write FieldDataFileImportDefinitionEnum)
- FileType
- Select the file type. (Read/Write FarFieldDataFileTypeEnum)
- Filename
- Import file containing the far field data. (Read/Write FileReference)
- Label
- The object label. (Read/Write string)
- LocalWorkplane
- The source workplane. (Read/Write LocalWorkplane)
- NumberPhiPoints
- The number of points along Phi. (Read/Write ParametricExpression)
- NumberThetaPoints
- The number of points along Theta. (Read/Write ParametricExpression)
- StartFromPoint
- The initial point to start with. (Read/Write ParametricExpression)
- 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 List of 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
- DataBlockNumber
- The data block that is first read from.
- Type
- ParametricExpression
- Access
- Read/Write
- FieldDataFileImportDefinitionTypeEnum
- The definition type used to import the file.
- Type
- FieldDataFileImportDefinitionEnum
- Access
- Read/Write
- FileType
- Select the file type.
- Type
- FarFieldDataFileTypeEnum
- Access
- Read/Write
- Filename
- Import file containing the far field data.
- Type
- FileReference
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- LocalWorkplane
- The source workplane.
- Type
- LocalWorkplane
- Access
- Read/Write
- NumberPhiPoints
- The number of points along Phi.
- Type
- ParametricExpression
- Access
- Read/Write
- NumberThetaPoints
- The number of points along Theta.
- Type
- ParametricExpression
- Access
- Read/Write
- StartFromPoint
- The initial point to start with.
- Type
- ParametricExpression
- 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.
- CopyAndRotate (properties table, count number)
- Apply a copy and rotate using a table defining the properties.
- CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
- Copy and rotate the geometry.
- CopyAndTranslate (properties table, count number)
- Apply a copy and translate using a table defining the properties.
- CopyAndTranslate (from Point, to Point, count number)
- Copy and translate the 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.