CharacteristicModesConfiguration
A characteristic modes configuration.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Add new characteristic modes configuration properties = cf.CharacteristicModesConfiguration.GetDefaultProperties() properties.Label = "CharacteristicModesConfiguration1" characteristicModesConfiguration = project.Contents.SolutionConfigurations:AddCharacteristicModesConfiguration(properties)
Inheritance
The CharacteristicModesConfiguration object is derived from the SolutionConfiguration object.
Usage locations
The CharacteristicModesConfiguration object can be accessed from the following locations:
- Methods
- SolutionConfigurationCollection collection has method AddCharacteristicModes(Expression).
Property List
- CharacteristicModes
- The characteristic modes request. (Read only CharacteristicModes)
- Frequency
- The configuration solution frequency. (Read only Frequency)
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- Type
- The object type string. (Read only string)
Collection List
- Currents
- The collection of currents requests in the configuration. (CurrentsCollection of Currents.)
- FarFields
- The collection of far field requests in the configuration. (FarFieldCollection of FarField.)
- Loads
- The collection of loads in the configuration. (LoadCollection of Load.)
- NearFields
- The collection of near field requests in the configuration. (NearFieldCollection of NearField.)
- Sources
- The collection of sources in the configuration. (SourceCollection of Source.)
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
- CharacteristicModes
- The characteristic modes request.
- Type
- CharacteristicModes
- Access
- Read only
- Frequency
- The configuration solution frequency.
- Type
- Frequency
- Access
- Read only
- 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
- Type
- The object type string.
- Type
- string
- Access
- Read only
Collection Details
- Currents
- The collection of currents requests in the configuration.
- Type
- CurrentsCollection
- FarFields
- The collection of far field requests in the configuration.
- Type
- FarFieldCollection
- Loads
- The collection of loads in the configuration.
- Type
- LoadCollection
- NearFields
- The collection of near field requests in the configuration.
- Type
- NearFieldCollection
- Sources
- The collection of sources in the configuration.
- Type
- SourceCollection
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.