Power

The power settings.

Example

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

    -- The power object is always there, obtain a handle

power = project.Contents.SolutionConfigurations.GlobalPower

    -- Set the power scale setting

power.ScaleSettings = cf.Enums.PowerScaleSettingsEnum.NoPowerScaling

Inheritance

The Power object is derived from the Object object.

Usage locations

The Power object can be accessed from the following locations:

Property List

DecoupleSourcesEnabled
The option to decouple all sources when calculating power. (Read/Write boolean)
Label
The object label. (Read/Write string)
ScaleSettings
The scale settings specified by the PowerScaleSettingsEnum, e.g. NoPowerScaling, TotalSourcePower, etc. (Read/Write PowerScaleSettingsEnum)
SourcePower
The source power (Watt). (Read/Write ParametricExpression)
Type
The object type string. (Read only string)
Z0Imaginary
The imaginary part of the characteristic impedance (Z0). (Read/Write ParametricExpression)
Z0Real
The real part of the characteristic impedance (Z0). (Read/Write ParametricExpression)

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

DecoupleSourcesEnabled
The option to decouple all sources when calculating power.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
ScaleSettings
The scale settings specified by the PowerScaleSettingsEnum, e.g. NoPowerScaling, TotalSourcePower, etc.
Type
PowerScaleSettingsEnum
Access
Read/Write
SourcePower
The source power (Watt).
Type
ParametricExpression
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Z0Imaginary
The imaginary part of the characteristic impedance (Z0).
Type
ParametricExpression
Access
Read/Write
Z0Real
The real part of the characteristic impedance (Z0).
Type
ParametricExpression
Access
Read/Write

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.