Currents
A solution currents request.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Request the calculation of all currents currentsRequest = project.Contents.SolutionConfigurations[1].Currents:Add()
Inheritance
Usage locations
The Currents object can be accessed from the following locations:
- Methods
- CurrentsCollection collection has method Add(table).
- CurrentsCollection collection has method Add().
- CurrentsCollection collection has method Item(number).
- CurrentsCollection collection has method Item(string).
Property List
- CalculationScope
- The calculation scope. (Read/Write CurrentsScopeTypeEnum)
- ExportSettings
- Currents export options. (Read/Write CurrentsExportSettings)
- Included
- A boolean value defining if an entity is excluded or included. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- ScopedEntities
- The entities for which the currents calculation will be done. (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
- CalculationScope
- The calculation scope.
- Type
- CurrentsScopeTypeEnum
- Access
- Read/Write
- ExportSettings
- Currents export options.
- Type
- CurrentsExportSettings
- 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
- ScopedEntities
- The entities for which the currents calculation will be done.
- 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.