`Reciprocity`

A solution reciprocity request.

Example

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

    -- Add a line, attach a wire port to it, and add a load

line = project.Contents.Geometry:AddLine(cf.Point(0,0,0), cf.Point(0,0,1))
wirePort = project.Contents.Ports:AddWirePort(line.Wires[1])
load = project.Contents.SolutionConfigurations.GlobalLoads:AddComplex(wirePort, 50, 0)

    -- Add a reciprocal excitation configuration

reciprocalExcitationConfiguration = project.Contents.SolutionConfigurations:AddReciprocalExcitationConfiguration()

    -- Add the load to the reciprocal excitation configuration

properties = reciprocalExcitationConfiguration:GetProperties()
properties.Reciprocity.Loads[1] = {}
properties.Reciprocity.Loads[1] = load
reciprocalExcitationConfiguration:SetProperties(properties)

Inheritance

The Reciprocity object is derived from the Object object.

Usage locations

The Reciprocity object can be accessed from the following locations:

Properties
- ReciprocalExcitationConfiguration object has property Reciprocity.

Property List

Included: A boolean value defining if an entity is excluded or included. (Read/Write boolean)
Label: The object label. (Read/Write string)
Loads: The list of loads for the reciprocal excitation configuration. (Read/Write ObjectReferenceList)
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

Included

A boolean value defining if an entity is excluded or included.

Type: boolean
Access: Read/Write

Label

The object label.

Type: string
Access: Read/Write

Loads

The list of loads for the reciprocal excitation configuration.

Type: ObjectReferenceList
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.