Oasys.D3PLOT.Group class

Properties

property Group.label: integer

The group label

property Group.model: Model

The Model that the group is in

property Group.title: string

The group title

property Group.type: constant

The type for the group (will be Type.GROUP)

Constructor

classmethod Group(model)

Creates a new group in D3PLOT

Parameters:

model (Model object) – The model to create the group in

Returns:

Group object

Return type:

Group

Example

To create a group for Model m in D3PLOT

g = Oasys.D3PLOT.Group(m)

Static methods

classmethod Group.First(model)

Returns the first group in the model (or None if there are no groups)

Parameters:

model (Model) – Model to get first group in

Returns:

Group object

Return type:

Group

Example

To get the first group in model m:

g = Oasys.D3PLOT.Group.First(m)

classmethod Group.GetFromID(model, label)

Returns the Group object for group in model with label (or None if it does not exist)

Parameters:

• model (Model) – Model to get group in

• label (integer) – The label for the group in the model

Returns:

Group object

Return type:

Group

Example

To get the group in model m with label 2:

g = Oasys.D3PLOT.Group.GetFromID(m, 2)

classmethod Group.Last(model)

Returns the last group in the model (or None if there are no groups)

Parameters:

model (Model) – Model to get last group in

Returns:

Group object

Return type:

Group

Example

To get the last group in model m:

g = Oasys.D3PLOT.Group.Last(m)

classmethod Group.Total(model)

Returns the total number of groups in a model

Parameters:

model (Model) – Model to get group in

Returns:

The number of groups

Return type:

integer

Example

To get the number of groups in model m:

total = Oasys.D3PLOT.Group.Total(m)

Instance methods

Group.AddFlagged(flag)

Adds flagged items to the contents of the group

Parameters:

flag (Flag) – Flag (see AllocateFlag) set on items to add to the group

Returns:

No return value

Return type:

None

Example

To add items flagged with flag f to group g:

g.AddFlagged(f)

Group.Empty()

Empties the group (removes everything from the group)

Returns:

No return value

Return type:

None

Example

To empty group g:

g.Empty()

Group.FlagContents(flag)

Flags the contents of the group

Parameters:

flag (Flag) – Flag (see AllocateFlag) to set for the group contents

Returns:

No return value

Return type:

None

Example

To flag the contents of group g with flag f:

g.FlagContents(f)

Group.Next()

Returns the next group in the model (or None if there is not one)

Returns:

Group object

Return type:

Group

Example

To get the next group after group g:

g = g.Next()

Group.Previous()

Returns the previous group in the model (or None if there is not one)

Returns:

Group object

Return type:

Group

Example

To get the previous group before group g:

g = g.Previous()