Oasys.PRIMER.Group class

Constants

Group.ADD

Add contents to group

Group.REMOVE

Remove contents from group

Properties

property Group.exists(read only): boolean

true if group exists, false if referred to but not defined

property Group.include: integer

The Include file number that the group is in

property Group.label: integer

Group number

property Group.lock: boolean

Whether Group contents are locked against deletion

property Group.model(read only): integer

The Model number that the group is in

property Group.numtypes(read only): integer

Number of types in the group

property Group.title: string

Group title

Constructor

classmethod Group(model, label, title=Oasys.gRPC.defaultArg)

Create a new Group object

Parameters:

  • model (Model) – Model that Group will be created in

  • label (integer) – Group number

  • title (string) – Optional. Title for the group

Returns:

Group object

Return type:

dict

Example

To create a new group 99 in model m with title “Example”:

g = Oasys.PRIMER.Group(m, 99, "Example")

Static methods

classmethod Group.BlankAll(model, redraw=Oasys.gRPC.defaultArg)

Blanks all of the groups in the model

Parameters:

  • model (Model) – Model that all groups will be blanked in

  • redraw (boolean) – Optional. If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw()

Returns:

No return value

Return type:

None

Example

To blank all of the groups in model m:

Oasys.PRIMER.Group.BlankAll(m)
classmethod Group.BlankFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)

Blanks all of the flagged groups in the model

Parameters:

  • model (Model) – Model that all the flagged groups will be blanked in

  • flag (Flag) – Flag set on the groups that you want to blank

  • redraw (boolean) – Optional. If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw()

Returns:

No return value

Return type:

None

Example

To blank all of the groups in model m flagged with f:

Oasys.PRIMER.Group.BlankFlagged(m, f)
classmethod Group.Create(model, modal=Oasys.gRPC.defaultArg)

Starts an interactive editing panel to create a group

Parameters:

  • model (Model) – Model that the group will be created in

  • modal (boolean) – Optional. If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal

Returns:

Group object (or None if not made)

Return type:

dict

Example

To start creating a group g in model m:

g = Oasys.PRIMER.Group.Create(m)
classmethod Group.First(model)

Returns the first group in the model

Parameters:

model (Model) – Model to get first group in

Returns:

Group object (or None if there are no groups in the model)

Return type:

Group

Example

To get the first group in model m:

g = Oasys.PRIMER.Group.First(m)
classmethod Group.FirstFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the first free group label in the model. Also see Group.LastFreeLabel(), Group.NextFreeLabel() and Model.FirstFreeItemLabel()

Parameters:

  • model (Model) – Model to get first free group label in

  • layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to First free in layer in editing panels). If omitted the whole model will be used (Equivalent to First free in editing panels)

Returns:

Group label

Return type:

int

Example

To get the first free group label in model m:

label = Oasys.PRIMER.Group.FirstFreeLabel(m)
classmethod Group.FlagAll(model, flag)

Flags all of the groups in the model with a defined flag

Parameters:

  • model (Model) – Model that all groups will be flagged in

  • flag (Flag) – Flag to set on the groups

Returns:

No return value

Return type:

None

Example

To flag all of the groups with flag f in model m:

Oasys.PRIMER.Group.FlagAll(m, f)
classmethod Group.GetAll(model)

Returns a list of Group objects for all of the groups in a model in PRIMER

Parameters:

model (Model) – Model to get groups from

Returns:

List of Group objects

Return type:

list

Example

To make a list of Group objects for all of the groups in model m

g = Oasys.PRIMER.Group.GetAll(m)
classmethod Group.GetFlagged(model, flag)

Returns a list of Group objects for all of the flagged groups in a model in PRIMER

Parameters:

  • model (Model) – Model to get groups from

  • flag (Flag) – Flag set on the groups that you want to retrieve

Returns:

List of Group objects

Return type:

list

Example

To make a list of Group objects for all of the groups in model m flagged with f

g = Oasys.PRIMER.Group.GetFlagged(m, f)
classmethod Group.GetFromID(model, number)

Returns the Group object for a group ID

Parameters:

  • model (Model) – Model to find the group in

  • number (integer) – number of the group you want the Group object for

Returns:

Group object (or None if group does not exist)

Return type:

Group

Example

To get the Group object for group 100 in model m

g = Oasys.PRIMER.Group.GetFromID(m, 100)
classmethod Group.Last(model)

Returns the last group in the model

Parameters:

model (Model) – Model to get last group in

Returns:

Group object (or None if there are no groups in the model)

Return type:

Group

Example

To get the last group in model m:

g = Oasys.PRIMER.Group.Last(m)
classmethod Group.LastFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the last free group label in the model. Also see Group.FirstFreeLabel(), Group.NextFreeLabel() and see Model.LastFreeItemLabel()

Parameters:

  • model (Model) – Model to get last free group label in

  • layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to Highest free in layer in editing panels). If omitted the whole model will be used

Returns:

Group label

Return type:

int

Example

To get the last free group label in model m:

label = Oasys.PRIMER.Group.LastFreeLabel(m)
classmethod Group.NextFreeLabel(model, layer=Oasys.gRPC.defaultArg)

Returns the next free (highest+1) group label in the model. Also see Group.FirstFreeLabel(), Group.LastFreeLabel() and Model.NextFreeItemLabel()

Parameters:

  • model (Model) – Model to get next free group label in

  • layer (Include number) – Optional. Include file (0 for the main file) to search for labels in (Equivalent to Highest+1 in layer in editing panels). If omitted the whole model will be used (Equivalent to Highest+1 in editing panels)

Returns:

Group label

Return type:

int

Example

To get the next free group label in model m:

label = Oasys.PRIMER.Group.NextFreeLabel(m)
classmethod Group.Pick(prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg, button_text=Oasys.gRPC.defaultArg)

Allows the user to pick a group

Parameters:

  • prompt (string) – Text to display as a prompt to the user

  • limit (Model or Flag) – Optional. If the argument is a Model then only groups from that model can be picked. If the argument is a Flag then only groups that are flagged with limit can be selected. If omitted, or None, any groups from any model can be selected. from any model

  • modal (boolean) – Optional. If picking is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the pick will be modal

  • button_text (string) – Optional. By default the window with the prompt will have a button labelled ‘Cancel’ which if pressed will cancel the pick and return None. If you want to change the text on the button use this argument. If omitted ‘Cancel’ will be used

Returns:

Group object (or None if not picked)

Return type:

dict

Example

To pick a group from model m giving the prompt ‘Pick group from screen’:

g = Oasys.PRIMER.Group.Pick('Pick group from screen', m)
classmethod Group.RenumberAll(model, start)

Renumbers all of the groups in the model

Parameters:

  • model (Model) – Model that all groups will be renumbered in

  • start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the groups in model m, from 1000000:

Oasys.PRIMER.Group.RenumberAll(m, 1000000)
classmethod Group.RenumberFlagged(model, flag, start)

Renumbers all of the flagged groups in the model

Parameters:

  • model (Model) – Model that all the flagged groups will be renumbered in

  • flag (Flag) – Flag set on the groups that you want to renumber

  • start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the groups in model m flagged with f, from 1000000:

Oasys.PRIMER.Group.RenumberFlagged(m, f, 1000000)
classmethod Group.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)

Allows the user to select groups using standard PRIMER object menus

Parameters:

  • flag (Flag) – Flag to use when selecting groups

  • prompt (string) – Text to display as a prompt to the user

  • limit (Model or Flag) – Optional. If the argument is a Model then only groups from that model can be selected. If the argument is a Flag then only groups that are flagged with limit can be selected (limit should be different to flag). If omitted, or None, any groups can be selected. from any model

  • modal (boolean) – Optional. If selection is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the selection will be modal

Returns:

Number of groups selected or None if menu cancelled

Return type:

int

Example

To select groups from model m, flagging those selected with flag f, giving the prompt ‘Select groups’:

Oasys.PRIMER.Group.Select(f, 'Select groups', m)

To select groups, flagging those selected with flag f but limiting selection to groups flagged with flag l, giving the prompt ‘Select groups’:

Oasys.PRIMER.Group.Select(f, 'Select groups', l)
classmethod Group.SketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)

Sketches all of the flagged groups in the model. The groups will be sketched until you either call Group.Unsketch(), Group.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

Parameters:

  • model (Model) – Model that all the flagged groups will be sketched in

  • flag (Flag) – Flag set on the groups that you want to sketch

  • redraw (boolean) – Optional. If model should be redrawn or not after the groups are sketched. If omitted redraw is true. If you want to sketch flagged groups several times and only redraw after the last one then use false for redraw and call View.Redraw()

Returns:

No return value

Return type:

None

Example

To sketch all groups flagged with flag in model m:

Oasys.PRIMER.Group.SketchFlagged(m, flag)
classmethod Group.Total(model, exists=Oasys.gRPC.defaultArg)

Returns the total number of groups in the model

Parameters:

  • model (Model) – Model to get total for

  • exists (boolean) – Optional. true if only existing groups should be counted. If false or omitted referenced but undefined groups will also be included in the total

Returns:

number of groups

Return type:

int

Example

To get the total number of groups in model m:

total = Oasys.PRIMER.Group.Total(m)
classmethod Group.UnblankAll(model, redraw=Oasys.gRPC.defaultArg)

Unblanks all of the groups in the model

Parameters:

  • model (Model) – Model that all groups will be unblanked in

  • redraw (boolean) – Optional. If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw()

Returns:

No return value

Return type:

None

Example

To unblank all of the groups in model m:

Oasys.PRIMER.Group.UnblankAll(m)
classmethod Group.UnblankFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)

Unblanks all of the flagged groups in the model

Parameters:

  • model (Model) – Model that the flagged groups will be unblanked in

  • flag (Flag) – Flag set on the groups that you want to unblank

  • redraw (boolean) – Optional. If model should be redrawn or not. If omitted redraw is false. If you want to do several (un)blanks and only redraw after the last one then use false for all redraws apart from the last one. Alternatively you can redraw using View.Redraw()

Returns:

No return value

Return type:

None

Example

To unblank all of the groups in model m flagged with f:

Oasys.PRIMER.Group.UnblankFlagged(m, f)
classmethod Group.UnflagAll(model, flag)

Unsets a defined flag on all of the groups in the model

Parameters:

  • model (Model) – Model that the defined flag for all groups will be unset in

  • flag (Flag) – Flag to unset on the groups

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the groups in model m:

Oasys.PRIMER.Group.UnflagAll(m, f)
classmethod Group.UnsketchAll(model, redraw=Oasys.gRPC.defaultArg)

Unsketches all groups

Parameters:

  • model (Model) – Model that all groups will be unblanked in

  • redraw (boolean) – Optional. If model should be redrawn or not after the groups are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw()

Returns:

No return value

Return type:

None

Example

To unsketch all groups in model m:

Oasys.PRIMER.Group.UnsketchAll(m)
classmethod Group.UnsketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)

Unsketches all flagged groups in the model

Parameters:

  • model (Model) – Model that all groups will be unsketched in

  • flag (Flag) – Flag set on the groups that you want to unsketch

  • redraw (boolean) – Optional. If model should be redrawn or not after the groups are unsketched. If omitted redraw is true. If you want to unsketch several things and only redraw after the last one then use false for redraw and call View.Redraw()

Returns:

No return value

Return type:

None

Example

To unsketch all groups flagged with flag in model m:

Oasys.PRIMER.Group.UnsketchAll(m, flag)

Instance methods

Group.AssociateComment(comment)

Associates a comment with a group

Parameters:

comment (Comment) – Comment that will be attached to the group

Returns:

No return value

Return type:

None

Example

To associate comment c to the group g:

g.AssociateComment(c)
Group.Blank()

Blanks the group

Returns:

No return value

Return type:

None

Example

To blank group g:

g.Blank()
Group.Blanked()

Checks if the group is blanked or not

Returns:

True if blanked, False if not

Return type:

bool

Example

To check if group g is blanked:

if g.Blanked():
    do_something..
Group.Browse(modal=Oasys.gRPC.defaultArg)

Starts an edit panel in Browse mode

Parameters:

modal (boolean) – Optional. If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal

Returns:

no return value

Return type:

None

Example

To Browse group g:

g.Browse()
Group.ClearFlag(flag)

Clears a flag on the group

Parameters:

flag (Flag) – Flag to clear on the group

Returns:

No return value

Return type:

None

Example

To clear flag f for group g:

g.ClearFlag(f)
Group.Copy(range=Oasys.gRPC.defaultArg)

Copies the group. The target include of the copied group can be set using Options.copy_target_include

Parameters:

range (boolean) – Optional. If you want to keep the copied item in the range specified for the current include. Default value is false. To set current include, use Include.MakeCurrentLayer()

Returns:

Group object

Return type:

Group

Example

To copy group g into group z:

z = g.Copy()
Group.DetachComment(comment)

Detaches a comment from a group

Parameters:

comment (Comment) – Comment that will be detached from the group

Returns:

No return value

Return type:

None

Example

To detach comment c from the group g:

g.DetachComment(c)
Group.Edit(modal=Oasys.gRPC.defaultArg)

Starts an interactive editing panel

Parameters:

modal (boolean) – Optional. If this window is modal (blocks the user from doing anything else in PRIMER until this window is dismissed). If omitted the window will be modal

Returns:

no return value

Return type:

None

Example

To Edit group g:

g.Edit()
Group.Flagged(flag)

Checks if the group is flagged or not

Parameters:

flag (Flag) – Flag to test on the group

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if group g has flag f set on it:

if g.Flagged(f):
    do_something..
Group.GetComments()

Extracts the comments associated to a group

Returns:

List of Comment objects (or None if there are no comments associated to the node)

Return type:

list

Example

To get the list of comments associated to the group g:

comm_list = g.GetComments()
Group.GetDataAll(type, index)

Returns ‘all’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘all’ row you want the data for. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalAll()

Returns:

A list containing data [Group.ADD or Group.REMOVE, BOX (if defined)]

Return type:

list

Example

To get the data for the 3rd SHELL ‘all’ row in group g:

data = g.GetDataAll("SHELL", 2)
Group.GetDataList(type, index)

Returns ‘list’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘list’ row you want the data for. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalList()

Returns:

A list containing data [Group.ADD or Group.REMOVE, ITEM1 (if defined), ITEM2 (if defined), ITEM3 (if defined), ITEM4 (if defined), ITEM5 (if defined), BOX (if defined)]

Return type:

list

Example

To get the data for the 3rd SHELL ‘list’ row in group g:

data = g.GetDataList("SHELL", 2)
Group.GetDataRange(type, index)

Returns ‘range’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘range’ row you want the data for. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalRange()

Returns:

A list containing data [Group.ADD or Group.REMOVE, START, END, BOX (if defined)]

Return type:

list

Example

To get the data for the 3rd SHELL ‘range’ row in group g:

data = g.GetDataRange("SHELL", 2)
Group.GetParameter(prop)

Checks if a Group property is a parameter or not. Note that object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. For this function to work the JavaScript interpreter must use the parameter name instead of the value. This can be done by setting the Options.property_parameter_names option to true before calling the function and then resetting it to false afterwards.. This behaviour can also temporarily be switched by using the Group.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

prop (string) – group property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

To check if Group property g.example is a parameter:

Oasys.PRIMER.Options.property_parameter_names = True
if g.GetParameter(g.example):
    do_something...
Oasys.PRIMER.Options.property_parameter_names = False

To check if Group property g.example is a parameter by using the GetParameter method:

if g.ViewParameters().GetParameter(g.example):
    do_something..
Group.GetTotalAll(type)

Returns the total number of ‘all’ rows for a type in a group

Parameters:

type (string) – The type of the item

Returns:

The number of ‘all’ rows defined

Return type:

int

Example

To get the total number of shell ‘all’ rows in group g:

nrow = g.GetTotalAll("SHELL")
Group.GetTotalList(type)

Returns the total number of ‘list’ rows for a type in a group

Parameters:

type (string) – The type of the item

Returns:

The number of ‘list’ rows defined

Return type:

int

Example

To get the total number of shell ‘list’ rows in group g:

nrow = g.GetTotalList("SHELL")
Group.GetTotalRange(type)

Returns the total number of ‘range’ rows for a type in a group

Parameters:

type (string) – The type of the item

Returns:

The number of ‘range’ rows defined

Return type:

int

Example

To get the total number of shell ‘range’ rows in group g:

nrow = g.GetTotalRange("SHELL")
Group.GetTotals(type)

Returns the total number of ‘all’, ‘list’ and ‘range’ rows for a type in a group

Parameters:

type (string) – The type of the item

Returns:

List containing number of ‘all’, ‘list’ and ‘range’ rows defined or None if type not in group

Return type:

list

Example

To get the total number of shell ‘all’, ‘list’ and ‘range’ rows in group g:

totals = g.GetTotals("SHELL")
nall = totals[0]
nlist = totals[1]
nrange = totals[2]
Group.GetType(row)

Returns the type for an entry in a group

Parameters:

row (integer) – The entry in the group types that you want the type for. Note that entries start at 0, not 1

Returns:

The type of the item (string)

Return type:

str

Example

To list the types that are present in group g:

for t in range(g.numtypes):
    type = g.GetType(t)
    print(type)
Group.Keyword()

Returns the keyword for this group. Note that a carriage return is not added. See also Group.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for goup g:

key = g.Keyword()
Group.KeywordCards()

Returns the keyword cards for the Group. Note that a carriage return is not added. See also Group.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for Group g:

cards = g.KeywordCards()
Group.Next()

Returns the next group in the model

Returns:

Group object (or None if there are no more groups in the model)

Return type:

Group

Example

To get the group in model m after group g:

g = g.Next()
Group.Previous()

Returns the previous group in the model

Returns:

Group object (or None if there are no more groups in the model)

Return type:

Group

Example

To get the group in model m before group g:

g = g.Previous()
Group.RemoveDataAll(type, index)

Removes ‘all’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘all’ row you want to Remove. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalAll()

Returns:

No return value

Return type:

None

Example

To remove the data for the 3rd SHELL ‘all’ row in group g:

g.RemoveDataAll("SHELL", 2)
Group.RemoveDataList(type, index)

Removes ‘list’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘list’ row you want to Remove. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalList()

Returns:

No return value

Return type:

None

Example

To remove the data for the 3rd SHELL ‘list’ row in group g:

g.RemoveDataList("SHELL", 2)
Group.RemoveDataRange(type, index)

Removes ‘range’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘range’ row you want to Remove. Note that indices start at 0, not 1.
    0 <= index < Group.GetTotalRange()

Returns:

No return value

Return type:

None

Example

To remove the data for the 3rd SHELL ‘range’ row in group g:

g.RemoveDataRange("SHELL", 2)
Group.SetDataAll(type, index, data)

Sets ‘all’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘all’ row you want the data for. Note that indices start at 0, not 1.
    0 <= index <= Group.GetTotalAll()

  • data (List of data) – An list containing data [Group.ADD or Group.REMOVE, BOX (if defined)]

Returns:

No return value

Return type:

None

Example

To set the data for the 3rd SHELL ‘all’ row in group g to ‘add box 10’:

data = [Oasys.PRIMER.Group.ADD, 10]
g.SetDataAll("SHELL", 2, data)
Group.SetDataList(type, index, data)

Sets ‘list’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘list’ row you want the data for. Note that indices start at 0, not 1.
    0 <= index <= Group.GetTotalList()

  • data (List of data) – An list containing data [Group.ADD or Group.REMOVE, ITEM1 (if defined), ITEM2 (if defined), ITEM3 (if defined), ITEM4 (if defined), ITEM5 (if defined), BOX (if defined)]

Returns:

No return value

Return type:

None

Example

To set the data for the 3rd SHELL ‘list’ row in group g to ‘add 1 2 box 10’:

data = [Oasys.PRIMER.Group.ADD, 1, 2, 0, 0, 0, 10]
g.SetDataList("SHELL", 2, data)
Group.SetDataRange(type, index, data)

Sets ‘range’ data for a given row number and type in the group

Parameters:

  • type (string) – The type of the item

  • index (integer) – Index of ‘all’ row you want the data for. Note that indices start at 0, not 1.
    0 <= index <= Group.GetTotalRange()

  • data (List of data) – An list containing data [Group.ADD or Group.REMOVE, START, END, BOX (if defined)]

Returns:

No return value

Return type:

None

Example

To set the data for the 3rd SHELL ‘range’ row in group g to ‘add 100 200 box 10’:

data = [Oasys.PRIMER.Group.ADD, 100, 200, 10]
g.SetDataRange("SHELL", 2, data)
Group.SetFlag(flag)

Sets a flag on the group

Parameters:

flag (Flag) – Flag to set on the group

Returns:

No return value

Return type:

None

Example

To set flag f for group g:

g.SetFlag(f)
Group.Sketch(redraw=Oasys.gRPC.defaultArg)

Sketches the group. The group will be sketched until you either call Group.Unsketch(), Group.UnsketchAll(), Model.UnsketchAll(), or delete the model

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the group is sketched. If omitted redraw is true. If you want to sketch several groups and only redraw after the last one then use false for redraw and call View.Redraw()

Returns:

No return value

Return type:

None

Example

To sketch group g:

g.Sketch()
Group.Unblank()

Unblanks the group

Returns:

No return value

Return type:

None

Example

To unblank group g:

g.Unblank()
Group.Unsketch(redraw=Oasys.gRPC.defaultArg)

Unsketches the group

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the group is unsketched. If omitted redraw is true. If you want to unsketch several groups and only redraw after the last one then use false for redraw and call View.Redraw()

Returns:

No return value

Return type:

None

Example

To unsketch group g:

g.Unsketch()
Group.ViewParameters()

Object properties that are parameters are normally returned as the integer or float parameter values as that is virtually always what the user would want. This function temporarily changes the behaviour so that if a property is a parameter the parameter name is returned instead. This can be used with ‘method chaining’ (see the example below) to make sure a property argument is correct

Returns:

Group object

Return type:

dict

Example

To check if Group property g.example is a parameter by using the Group.GetParameter() method:

if g.ViewParameters().GetParameter(g.example):
    do_something..
Group.Xrefs()

Returns the cross references for this group

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for group g:

xrefs = g.Xrefs()