CurrentsCollection
A collection of solution currents for this solution configuration.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Add a currents request to the currents collection currentsCollection = project.Contents.SolutionConfigurations[1].Currents currentsRequest = currentsCollection:Add() -- Remove the currents request from the currents collection currentsCollection:Item(currentsRequest.Label):Delete()
Inheritance
The CurrentsCollection object is derived from the Object object.
Usage locations
The CurrentsCollection object can be accessed from the following locations:
- Collection lists
- CharacteristicModesConfiguration object has collection Currents.
- StandardConfiguration object has collection Currents.
Property List
Method List
- Add (properties table)
- Create a currents calculation using the table of properties. (Returns a Currents object.)
- Add ()
- Request a currents calculation. (Returns a Currents object.)
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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.)
- Item (index number)
- Returns the Currents for the given index in the collection. (Returns a Currents object.)
- Item (label string)
- Returns the Currents for the given label in the collection. (Returns a Currents object.)
- Items ()
- Returns a table of Currents items. (Returns a UnsupportedType(List of Currents) 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
Method Details
- Add (properties table)
- Create a currents calculation using the table of properties.
- Add ()
- Request a currents calculation.
- Return
- Currents
- The currents request.
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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.
- Item (index number)
- Returns the Currents for the given index in the collection.
- Item (label string)
- Returns the Currents for the given label in the collection.
- Items ()
- Returns a table of Currents items.
- Return
- UnsupportedType(List of Currents)
- The list of items in the collection
- 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.