# Load

A solution load.

## Example

app = cf.GetApplication()
project = app:NewProject()
standardConfiguration = project.SolutionConfigurations['StandardConfiguration1']
femLinePort = project.Ports:AddFEMLinePortBetweenPoints(cf.Point(0,0,0) ,cf.Point(1,1,0) )

--  Add a complex load to the terminal of the line port.

complexLoad = standardConfiguration.Loads:AddComplex(femLinePort.Terminal,"220","0")

-- Make the load visible

complexLoad.Visible = true


## Inheritance

The Load object is derived from the SolutionEntity object.

## Property List

Capacitance
The capacitive aspect of the series or parallel circuit load definition (F). Changing this property will set CapacitanceEnabled to true. (Read/Write Expression)
CapacitanceEnabled
Specifies if the Capacitance property should be used. (Read/Write boolean)
Filename
The single port Touchstone or SPICE filename that describes the load. (Read/Write string)
ImpedanceImaginary
The reactive part of the complex impedance (Ohm). (Read/Write Expression)
ImpedanceReal
The real part of the complex impedance (Ohm). (Read/Write Expression)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Inductance
The inductive aspect of the series or parallel circuit load definition (H). Changing this property will set InductanceEnabled to true. (Read/Write Expression)
InductanceEnabled
Specifies if the Inductance property should be used. (Read/Write boolean)
Label
The object label. (Read/Write string)
LoadType
The load construction type. (Read/Write LoadTypeEnum)
Resistance
The resistive aspect of the series or parallel circuit load definition (Ohm). Changing this property will set ResistanceEnabled to true. (Read/Write Expression)
ResistanceEnabled
Specifies if the Resistance property should be used. (Read/Write boolean)
Terminal
The port terminal connected to the load. (Read/Write Terminal)
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

Capacitance
The capacitive aspect of the series or parallel circuit load definition (F). Changing this property will set CapacitanceEnabled to true.
Type
Expression
Access
Read/Write
CapacitanceEnabled
Specifies if the Capacitance property should be used.
Type
boolean
Access
Read/Write
Filename
The single port Touchstone or SPICE filename that describes the load.
Type
string
Access
Read/Write
ImpedanceImaginary
The reactive part of the complex impedance (Ohm).
Type
Expression
Access
Read/Write
ImpedanceReal
The real part of the complex impedance (Ohm).
Type
Expression
Access
Read/Write
Included
Specifies whether the solution entity must be included or excluded.
Type
boolean
Access
Read/Write
Inductance
The inductive aspect of the series or parallel circuit load definition (H). Changing this property will set InductanceEnabled to true.
Type
Expression
Access
Read/Write
InductanceEnabled
Specifies if the Inductance property should be used.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LoadType
The load construction type.
Type
LoadTypeEnum
Access
Read/Write
Resistance
The resistive aspect of the series or parallel circuit load definition (Ohm). Changing this property will set ResistanceEnabled to true.
Type
Expression
Access
Read/Write
ResistanceEnabled
Specifies if the Resistance property should be used.
Type
boolean
Access
Read/Write
Terminal
The port terminal connected to the load.
Type
Terminal
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.