RATagging

class RATagging

Rocky PrePost Scripting wrapper to manipulate Tagging Calculators in a project.

The class corresponds to an individual “Tagging” calculation under the “Particles Calculation” item on the project’s data tree. To create the RATagging from a RACalculations, use:

selection_process = study.GetElement('Particles')
particles_calculations = study.GetCalculations()
tagging = particles_calculations.CreateTagging(selection_process)

Methods:

Name	Description
`GetGridFunctionName`()	Get the tagging grid function name.
`GetNameMask`()	Get the value of "Name Mask".
`GetTagValue`()	Get the value of "Tag Value".
`GetTimeRangeFilter`()	Get the API object that wraps the specific Time Range Filter.
`SetNameMask`(value)	Set the value of "Name Mask".
`SetTagValue`(value)	Set the value of "Tag Value".

GetGridFunctionName()

Get the tagging grid function name. This name can be used to access the tagging grid function on a particle-based process. :rtype: str

GetNameMask()

Get the value of “Name Mask”.

GetTagValue()

Get the value of “Tag Value”.

GetTimeRangeFilter()

Get the API object that wraps the specific Time Range Filter. :rtype: RATimeRangeFilter

SetNameMask(value: str)

Set the value of “Name Mask”.

Parameters: value – The value to set.

SetTagValue(value: str | int)

Set the value of “Tag Value”.

Parameters: value – The value to set. This value can be an expression with input variables or int type.

Rocky PrePost scripting 2026 R1