SAR

A SAR request.

Example

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

-- Create a SAR request

configuration = project.SolutionConfigurations[1]


Inheritance

The SAR object is derived from the SolutionEntity object.

Usage locations (object properties)

The following objects have properties using the SAR object:

Property List

CalculationType
The SAR calculation type. (Read/Write SARCalculationTypeEnum)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
LayerSelection
Specifies if all layers or a specific layer should be used for the SAR calculation when when the 'RegionType' is 'Substrate'. (Read/Write SARLocationOptionTypeEnum)
MediaSelection
Specifies if all media or a specific medium should be used for the SAR calculation when when the 'RegionType' is 'Medium'. (Read/Write SARLocationOptionTypeEnum)
RegionType
The region over which to calculate the SAR. (Read/Write SARRegionTypeEnum)
SpecifiedMedium
Specifies the medium to use for the SAR calculation when 'MediaSelection' is 'Specified'. (Read/Write Medium)
SpecifiedPosition
Specifies the position to use for the SAR calculation when the 'RegionType' is 'Position'. (Read/Write GlobalCoordinates)
SubstrateLayer
The substrate layer to use when the 'RegionType' is 'Substrate'. (Read/Write Expression)
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

CalculationType
The SAR calculation type.
Type
SARCalculationTypeEnum
Access
Included
Specifies whether the solution entity must be included or excluded.
Type
boolean
Access
Label
The object label.
Type
string
Access
LayerSelection
Specifies if all layers or a specific layer should be used for the SAR calculation when when the 'RegionType' is 'Substrate'.
Type
SARLocationOptionTypeEnum
Access
MediaSelection
Specifies if all media or a specific medium should be used for the SAR calculation when when the 'RegionType' is 'Medium'.
Type
SARLocationOptionTypeEnum
Access
RegionType
The region over which to calculate the SAR.
Type
SARRegionTypeEnum
Access
SpecifiedMedium
Specifies the medium to use for the SAR calculation when 'MediaSelection' is 'Specified'.
Type
Medium
Access
SpecifiedPosition
Specifies the position to use for the SAR calculation when the 'RegionType' is 'Position'.
Type
GlobalCoordinates
Access
SubstrateLayer
The substrate layer to use when the 'RegionType' is 'Substrate'.
Type
Expression
Access
Type
The object type string.
Type
string
Access
Visible
Specifies whether the solution entity must be shown or hidden.
Type
boolean
Access

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.