CharacteristicModes
A solution characteristic modes analysis request.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Request a characteristic modes analysis characteristicModesConfiguration = project.Contents.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 Object object.
Usage locations
The CharacteristicModes object can be accessed from the following locations:
- Properties
- CharacteristicModesConfiguration object has property CharacteristicModes.
Property List
- CoefficientsComputed
- Compute the source coefficients. (Read/Write boolean)
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- NumberOfModes
- The number of characteristic modes to calculate. (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
- CoefficientsComputed
- Compute the source coefficients.
- Type
- boolean
- Access
- Read/Write
- 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
- NumberOfModes
- The number of characteristic modes to calculate.
- 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.