RAInletsOutletsCollection

class RAInletsOutletsCollection

Rocky PrePost Scripting wrapper for the collection of particle inputs in a project.

This wrapper corresponds to the “Inputs” item in the project’s data tree. To retrieve the RAInletsOutletsCollection from a RAStudy, use:

input_collection = study.GetInletsOutletsCollection()

Instances of the RAInletsOutletsCollection class act as regular Python lists, and can be iterated on, accessed via index, etc:

input_1 = input_collection.New()
input_2 = input_collection[1]
del input_collection[0]
for input in input_collection:
    print(input.GetName())

Items in this list are of type RAParticleInlet.

Methods:

Name	Description
AddCustomInput()	Add a new CustomInput.
AddFluidInlet()	Add a new SPHInlet.
AddOutlet()	Add a new Outlet.
AddParticleInlet()	Add a new ParticleInlet.
AddVolumetricInlet()	Add a new VolumeFill.
Clear()	Remove all items from the list.
GetParticleInput(input_name)	Get the particle input with the given name.
GetParticleInputNames()	Get the names of all particle inputs.
New()	Add a new item.
Remove(item)	Remove an item from the list.

AddCustomInput()

Add a new CustomInput. Returns the newly created item.

AddFluidInlet()

Add a new SPHInlet. Returns the newly created item.

AddOutlet()

Add a new Outlet. Returns the newly created item.

AddParticleInlet()

Add a new ParticleInlet. Returns the newly created item.

AddVolumetricInlet()

Add a new VolumeFill. Returns the newly created item.

Clear()

Remove all items from the list.

GetParticleInput(input_name)

Get the particle input with the given name.

• Parameters: input_name (unicode)
• Return type: RAParticleInlet

GetParticleInputNames()

Get the names of all particle inputs.

• Return type: list(unicode)

New()

Add a new item. Returns the newly created item.

• Return type: ApiElementItem

Remove(item: T)

Remove an item from the list.