RADivisionsTagging

class RADivisionsTagging

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

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

selection_process = study.GetElement('Cube 01>)
particles_calculations = study.GetCalculations()
divisions_tagging = particles_calculations.CreateDivisionsTagging(selection_process)

Methods:

Name	Description
GetDivisionsI()	Get the value of "Divisions I".
GetDivisionsJ()	Get the value of "Divisions J".
GetDivisionsK()	Get the value of "Divisions K".
GetGridFunctionName()	Get the tagging grid function name.
GetNameMask()	Get the value of "Name Mask".
GetTagStride()	Get the value of "Tag Stride".
GetTagValue()	Get the value of "Tag Value".
GetTimeRangeFilter()	Get the API object that wraps the specific Time Range Filter.
SetDivisionsI(value)	Set the value of "Divisions I".
SetDivisionsJ(value)	Set the value of "Divisions J".
SetDivisionsK(value)	Set the value of "Divisions K".
SetNameMask(value)	Set the value of "Name Mask".
SetTagStride(value)	Set the value of "Tag Stride".
SetTagValue(value)	Set the value of "Tag Value".

GetDivisionsI()

Get the value of “Divisions I”.

GetDivisionsJ()

Get the value of “Divisions J”.

GetDivisionsK()

Get the value of “Divisions K”.

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”.

GetTagStride()

Get the value of “Tag Stride”.

GetTagValue()

Get the value of “Tag Value”.

GetTimeRangeFilter()

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

SetDivisionsI(value: Union[str, int])

Set the value of “Divisions I”.

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

SetDivisionsJ(value: Union[str, int])

Set the value of “Divisions J”.

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

SetDivisionsK(value: Union[str, int])

Set the value of “Divisions K”.

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

SetNameMask(value: str)

Set the value of “Name Mask”.

• Parameters: value – The value to set.

SetTagStride(value: Union[str, int])

Set the value of “Tag Stride”.

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

SetTagValue(value: Union[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.