CharacteristicModes

A solution characteristic modes analysis request.

Example

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

    -- Request a characteristic modes analysis
    
characteristicModesConfiguration = project.SolutionConfigurations:AddCharacteristicModes(6)

    -- Change the number of characteristic modes to calculate
    
characteristicModesRequest = characteristicModesConfiguration.CharacteristicModes
characteristicModesRequest.NumberOfModes = 5

Inheritance

The CharacteristicModes object is derived from the SolutionEntity object.

Usage locations (object properties)

The following objects have properties using the CharacteristicModes object:

Property List

CoefficientsComputed
Compute the source coefficients. (Read/Write boolean)
Included
Specifies whether the solution entity must be included or excluded. (Read/Write boolean)
Label
The object label. (Read/Write string)
NumberOfModes
The number of characteristic modes to calculate. (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

CoefficientsComputed
Compute the source coefficients.
Type
boolean
Access
Read/Write
Included
Specifies whether the solution entity must be included or excluded.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
NumberOfModes
The number of characteristic modes to calculate.
Type
Expression
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.