SAR

A SAR request.

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Create a SAR request

configuration = project.Contents.SolutionConfigurations[1]
SARRequest = configuration.SAR:Add()

Inheritance

The SAR object is derived from the Object object.

Usage locations

The SAR object can be accessed from the following locations:

Property List

CalculationType
The SAR calculation type. (Read/Write SARCalculationTypeEnum)
Label
The object label. (Read/Write string)
LayerSelection
Specifies if all layers or a specific layer should be used for the SAR calculation when when the 'RegionType' is 'Substrate'. (Read/Write SARSubstrateLayerSelectEnum)
MediaSelection
Specifies if all media or a specific medium should be used for the SAR calculation when when the 'RegionType' is 'Medium'. (Read/Write SARMediumSelectEnum)
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 ParametricExpression)
Type
The object type string. (Read only string)

Method List

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

CalculationType
The SAR calculation type.
Type
SARCalculationTypeEnum
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LayerSelection
Specifies if all layers or a specific layer should be used for the SAR calculation when when the 'RegionType' is 'Substrate'.
Type
SARSubstrateLayerSelectEnum
Access
Read/Write
MediaSelection
Specifies if all media or a specific medium should be used for the SAR calculation when when the 'RegionType' is 'Medium'.
Type
SARMediumSelectEnum
Access
Read/Write
RegionType
The region over which to calculate the SAR.
Type
SARRegionTypeEnum
Access
Read/Write
SpecifiedMedium
Specifies the medium to use for the SAR calculation when 'MediaSelection' is 'Specified'.
Type
Medium
Access
Read/Write
SpecifiedPosition
Specifies the position to use for the SAR calculation when the 'RegionType' is 'Position'.
Type
GlobalCoordinates
Access
Read/Write
SubstrateLayer
The substrate layer to use when the 'RegionType' is 'Substrate'.
Type
ParametricExpression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

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.