Scoping class

Namespace: Ans.DataProcessing

Summary

The scoping contains entities ids representing a subset of the model's support. Typically, scoping can represent node ids, element ids, time steps, frequencies, joints...

Its location indicates what kind of entity the scoping is referring to

Example

my_scoping = dpf.data.Scoping()

my_scoping.Location = 'Nodal' #optional

my_scoping.Ids = range(1,11)

Class Information

Property	Value
Namespace	Ans.DataProcessing
Assembly	CS_DataProcessing
Base Class	Ans.DataProcessing.internal_objects.DpfType

Constructors

Constructor

Scoping()

Constructor

Scoping(ptrScoping)

Parameters:

• ptrScoping (IntPtr)

Constructor

Scoping(ids, location)

Parameters:

• ids (list)
• location (str)

Methods

IdByIndex

result = obj.IdByIndex(index)

Parameters:

• index (int)

Returns: int

IndexById

result = obj.IndexById(id)

Parameters:

• id (int)

Returns: int

HasId

result = obj.HasId(id)

Parameters:

• id (int)

Returns: bool

GetInternalData

result = obj.GetInternalData()

Returns: IntPtr

Properties

Ids

Property Ids entity ids

Type: list

# Get or set the property
value = obj.Ids
obj.Ids = new_value

Count

Property Count returns the number of ids in the scoping

Type: int

# Get the property (read-only)
value = obj.Count

Location

Property Location indicates what kind of entity the scoping is referring to

Type: str

# Get or set the property
value = obj.Location
obj.Location = new_value