Oasys.PRIMER.NodalRigidBody class¶

Properties¶

property NodalRigidBody.cid: integer¶

Coordinate system ID

property NodalRigidBody.cmo: integer¶

Centre of mass option

property NodalRigidBody.colour: Colour¶

The colour of the nrb

property NodalRigidBody.con1: integer¶

First retraint parameter

property NodalRigidBody.con2: integer¶

Second retraint parameter

property NodalRigidBody.drflag: integer¶

Displacement release flag

property NodalRigidBody.exists(read only): boolean¶

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

property NodalRigidBody.idthrm: integer¶

Flag for the thermal constraint

property NodalRigidBody.include: integer¶

The Include file number that the nrb is in

property NodalRigidBody.inertia: boolean¶

Flag to turn on or off _INERTIA option

property NodalRigidBody.iprt: integer¶

Print flag

property NodalRigidBody.ixx: float¶

Ixx component of inertia tensor

property NodalRigidBody.ixy: float¶

Ixy component of inertia tensor

property NodalRigidBody.ixz: float¶

Ixz component of inertia tensor

property NodalRigidBody.iyy: float¶

Iyy component of inertia tensor

property NodalRigidBody.iyz: float¶

Iyz component of inertia tensor

property NodalRigidBody.izz: float¶

Izz component of inertia tensor

property NodalRigidBody.label: integer¶

NodalRigidBody ID of the NRB. Also see the pid property which is an alternative name for this

property NodalRigidBody.model(read only): integer¶

The Model number that the nodal rigid body is in

property NodalRigidBody.nodeid: integer¶

Optional node point

property NodalRigidBody.nsid: integer¶

Nodal set ID

property NodalRigidBody.override: boolean¶

Flag to turn on or off _OVERRIDE option

property NodalRigidBody.pid: integer¶

NodalRigidBody ID of the NRB. Also see the label property which is an alternative name for this

property NodalRigidBody.pnode: integer¶

Optional nodal point

property NodalRigidBody.rrflag: integer¶

Rotation release flag

property NodalRigidBody.spc: boolean¶

Flag to turn on or off _SPC option

property NodalRigidBody.thermal: boolean¶

Flag to turn on or off _THERMAL option

property NodalRigidBody.tm: float¶

Translational mass

property NodalRigidBody.vrx: float¶

X rigid body rotational velocity

property NodalRigidBody.vry: float¶

Y rigid body rotational velocity

property NodalRigidBody.vrz: float¶

Z rigid body rotational velocity

property NodalRigidBody.vtx: float¶

X rigid body translational velocity

property NodalRigidBody.vty: float¶

Y rigid body translational velocity

property NodalRigidBody.vtz: float¶

Z rigid body translational velocity

property NodalRigidBody.xc: float¶

X coordinate centre of mass

property NodalRigidBody.xl: float¶

X coordinate of local x axis

property NodalRigidBody.xlip: float¶

X coordinate of local in plane vector

property NodalRigidBody.yc: float¶

Y coordinate centre of mass

property NodalRigidBody.yl: float¶

Y coordinate of local x axis

property NodalRigidBody.ylip: float¶

Y coordinate of local in plane vector

property NodalRigidBody.zc: float¶

Z coordinate centre of mass

property NodalRigidBody.zl: float¶

Z coordinate of local x axis

property NodalRigidBody.zlip: float¶

Z coordinate of local in plane vector

Constructor¶

classmethod NodalRigidBody(model, nsid, pid=Oasys.gRPC.defaultArg, cid=Oasys.gRPC.defaultArg, pnode=Oasys.gRPC.defaultArg, iprt=Oasys.gRPC.defaultArg, drflag=Oasys.gRPC.defaultArg, rrflag=Oasys.gRPC.defaultArg)¶
Create a new NodalRigidBody object

Parameters:

model (Model) – Model that nrb will be created in

nsid (integer) – Nodal set ID

pid (integer) – Optional. NodalRigidBody ID of the NRB. Also see the label property which is an alternative name for this

cid (integer) – Optional. Coordinate system ID

pnode (integer) – Optional. Optional nodal point

iprt (integer) – Optional. Print flag

drflag (integer) – Optional. Displacement release flag

rrflag (integer) – Optional. Rotation release flag

Returns:

NodalRigidBody object

Return type:

dict

Example

To create a new nrb in model m with label 200, using node set 50
v = Oasys.PRIMER.NodalRigidBody(m, 50, 200)

Static methods¶

classmethod NodalRigidBody.BlankAll(model, redraw=Oasys.gRPC.defaultArg)¶
Blanks all of the nodal rigid bodys in the model

Parameters:

model (Model) – Model that all nodal rigid bodys 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 nodal rigid bodys in model m:
Oasys.PRIMER.NodalRigidBody.BlankAll(m)
classmethod NodalRigidBody.BlankFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Blanks all of the flagged nodal rigid bodys in the model

Parameters:

model (Model) – Model that all the flagged nodal rigid bodys will be blanked in

flag (Flag) – Flag set on the nodal rigid bodys 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 nodal rigid bodys in model m flagged with f:
Oasys.PRIMER.NodalRigidBody.BlankFlagged(m, f)
classmethod NodalRigidBody.Create(model, modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel to create a nrb

Parameters:

model (Model) – Model that the nrb 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:

NodalRigidBody object (or None if not made)

Return type:

dict

Example

To start creating a nrb in model m:
m = Oasys.PRIMER.NodalRigidBody.Create(m)
classmethod NodalRigidBody.First(model)¶
Returns the first nodal rigid body in the model

Parameters:

model (Model) – Model to get first nodal rigid body in

Returns:

NodalRigidBody object (or None if there are no nodal rigid bodys in the model)

Return type:

NodalRigidBody

Example

To get the first nodal rigid body in model m:
nrb = Oasys.PRIMER.NodalRigidBody.First(m)
classmethod NodalRigidBody.FirstFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the first free nodal rigid body label in the model. Also see NodalRigidBody.LastFreeLabel(), NodalRigidBody.NextFreeLabel() and Model.FirstFreeItemLabel()

Parameters:

model (Model) – Model to get first free nodal rigid body 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:

NodalRigidBody label

Return type:

int

Example

To get the first free nodal rigid body label in model m:
label = Oasys.PRIMER.NodalRigidBody.FirstFreeLabel(m)
classmethod NodalRigidBody.FlagAll(model, flag)¶
Flags all of the nodal rigid bodys in the model with a defined flag

Parameters:

model (Model) – Model that all nodal rigid bodys will be flagged in

flag (Flag) – Flag to set on the nodal rigid bodys

Returns:

No return value

Return type:

None

Example

To flag all of the nodal rigid bodys with flag f in model m:
Oasys.PRIMER.NodalRigidBody.FlagAll(m, f)
classmethod NodalRigidBody.GetAll(model)¶
Returns a list of NodalRigidBody objects for all of the nodal rigid bodys in a model in PRIMER

Parameters:

model (Model) – Model to get nodal rigid bodys from

Returns:

List of NodalRigidBody objects

Return type:

list

Example

To make a list of NodalRigidBody objects for all of the nodal rigid bodys in model m
nrb = Oasys.PRIMER.NodalRigidBody.GetAll(m)
classmethod NodalRigidBody.GetFlagged(model, flag)¶
Returns a list of NodalRigidBody objects for all of the flagged nodal rigid bodys in a model in PRIMER

Parameters:

model (Model) – Model to get nodal rigid bodys from

flag (Flag) – Flag set on the nodal rigid bodys that you want to retrieve

Returns:

List of NodalRigidBody objects

Return type:

list

Example

To make a list of NodalRigidBody objects for all of the nodal rigid bodys in model m flagged with f
nrb = Oasys.PRIMER.NodalRigidBody.GetFlagged(m, f)
classmethod NodalRigidBody.GetFromID(model, number)¶
Returns the NodalRigidBody object for a nodal rigid body ID

Parameters:

model (Model) – Model to find the nodal rigid body in

number (integer) – number of the nodal rigid body you want the NodalRigidBody object for

Returns:

NodalRigidBody object (or None if nodal rigid body does not exist)

Return type:

NodalRigidBody

Example

To get the NodalRigidBody object for nodal rigid body 100 in model m
nrb = Oasys.PRIMER.NodalRigidBody.GetFromID(m, 100)
classmethod NodalRigidBody.Last(model)¶
Returns the last nodal rigid body in the model

Parameters:

model (Model) – Model to get last nodal rigid body in

Returns:

NodalRigidBody object (or None if there are no nodal rigid bodys in the model)

Return type:

NodalRigidBody

Example

To get the last nodal rigid body in model m:
nrb = Oasys.PRIMER.NodalRigidBody.Last(m)
classmethod NodalRigidBody.LastFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the last free nodal rigid body label in the model. Also see NodalRigidBody.FirstFreeLabel(), NodalRigidBody.NextFreeLabel() and see Model.LastFreeItemLabel()

Parameters:

model (Model) – Model to get last free nodal rigid body 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:

NodalRigidBody label

Return type:

int

Example

To get the last free nodal rigid body label in model m:
label = Oasys.PRIMER.NodalRigidBody.LastFreeLabel(m)
classmethod NodalRigidBody.NextFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the next free (highest+1) nodal rigid body label in the model. Also see NodalRigidBody.FirstFreeLabel(), NodalRigidBody.LastFreeLabel() and Model.NextFreeItemLabel()

Parameters:

model (Model) – Model to get next free nodal rigid body 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:

NodalRigidBody label

Return type:

int

Example

To get the next free nodal rigid body label in model m:
label = Oasys.PRIMER.NodalRigidBody.NextFreeLabel(m)
classmethod NodalRigidBody.Pick(prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg, button_text=Oasys.gRPC.defaultArg)¶
Allows the user to pick a nodal rigid body

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 nodal rigid bodys from that model can be picked. If the argument is a Flag then only nodal rigid bodys that are flagged with limit can be selected. If omitted, or None, any nodal rigid bodys 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:

NodalRigidBody object (or None if not picked)

Return type:

dict

Example

To pick a nodal rigid body from model m giving the prompt ‘Pick nodal rigid body from screen’:
nrb = Oasys.PRIMER.NodalRigidBody.Pick('Pick nodal rigid body from screen', m)
classmethod NodalRigidBody.RenumberAll(model, start)¶
Renumbers all of the nodal rigid bodys in the model

Parameters:

model (Model) – Model that all nodal rigid bodys will be renumbered in

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the nodal rigid bodys in model m, from 1000000:
Oasys.PRIMER.NodalRigidBody.RenumberAll(m, 1000000)
classmethod NodalRigidBody.RenumberFlagged(model, flag, start)¶
Renumbers all of the flagged nodal rigid bodys in the model

Parameters:

model (Model) – Model that all the flagged nodal rigid bodys will be renumbered in

flag (Flag) – Flag set on the nodal rigid bodys that you want to renumber

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the nodal rigid bodys in model m flagged with f, from 1000000:
Oasys.PRIMER.NodalRigidBody.RenumberFlagged(m, f, 1000000)
classmethod NodalRigidBody.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select nodal rigid bodys using standard PRIMER object menus

Parameters:

flag (Flag) – Flag to use when selecting nodal rigid bodys

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

limit (Model or Flag) – Optional. If the argument is a Model then only nodal rigid bodys from that model can be selected. If the argument is a Flag then only nodal rigid bodys that are flagged with limit can be selected (limit should be different to flag). If omitted, or None, any nodal rigid bodys 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 nodal rigid bodys selected or None if menu cancelled

Return type:

int

Example

To select nodal rigid bodys from model m, flagging those selected with flag f, giving the prompt ‘Select nodal rigid bodys’:
Oasys.PRIMER.NodalRigidBody.Select(f, 'Select nodal rigid bodys', m)
To select nodal rigid bodys, flagging those selected with flag f but limiting selection to nodal rigid bodys flagged with flag l, giving the prompt ‘Select nodal rigid bodys’:
Oasys.PRIMER.NodalRigidBody.Select(f, 'Select nodal rigid bodys', l)
classmethod NodalRigidBody.SketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Sketches all of the flagged nodal rigid bodys in the model. The nodal rigid bodys will be sketched until you either call NodalRigidBody.Unsketch(), NodalRigidBody.UnsketchFlagged(), Model.UnsketchAll(), or delete the model

Parameters:

model (Model) – Model that all the flagged nodal rigid bodys will be sketched in

flag (Flag) – Flag set on the nodal rigid bodys that you want to sketch

redraw (boolean) – Optional. If model should be redrawn or not after the nodal rigid bodys are sketched. If omitted redraw is true. If you want to sketch flagged nodal rigid bodys 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 nodal rigid bodys flagged with flag in model m:
Oasys.PRIMER.NodalRigidBody.SketchFlagged(m, flag)
classmethod NodalRigidBody.Total(model, exists=Oasys.gRPC.defaultArg)¶
Returns the total number of nodal rigid bodys in the model

Parameters:

model (Model) – Model to get total for

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

Returns:

number of nodal rigid bodys

Return type:

int

Example

To get the total number of nodal rigid bodys in model m:
total = Oasys.PRIMER.NodalRigidBody.Total(m)
classmethod NodalRigidBody.UnblankAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unblanks all of the nodal rigid bodys in the model

Parameters:

model (Model) – Model that all nodal rigid bodys 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 nodal rigid bodys in model m:
Oasys.PRIMER.NodalRigidBody.UnblankAll(m)
classmethod NodalRigidBody.UnblankFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Unblanks all of the flagged nodal rigid bodys in the model

Parameters:

model (Model) – Model that the flagged nodal rigid bodys will be unblanked in

flag (Flag) – Flag set on the nodal rigid bodys 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 nodal rigid bodys in model m flagged with f:
Oasys.PRIMER.NodalRigidBody.UnblankFlagged(m, f)
classmethod NodalRigidBody.UnflagAll(model, flag)¶
Unsets a defined flag on all of the nodal rigid bodys in the model

Parameters:

model (Model) – Model that the defined flag for all nodal rigid bodys will be unset in

flag (Flag) – Flag to unset on the nodal rigid bodys

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the nodal rigid bodys in model m:
Oasys.PRIMER.NodalRigidBody.UnflagAll(m, f)
classmethod NodalRigidBody.UnsketchAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all nodal rigid bodys

Parameters:

model (Model) – Model that all nodal rigid bodys will be unblanked in

redraw (boolean) – Optional. If model should be redrawn or not after the nodal rigid bodys 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 nodal rigid bodys in model m:
Oasys.PRIMER.NodalRigidBody.UnsketchAll(m)
classmethod NodalRigidBody.UnsketchFlagged(model, flag, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all flagged nodal rigid bodys in the model

Parameters:

model (Model) – Model that all nodal rigid bodys will be unsketched in

flag (Flag) – Flag set on the nodal rigid bodys that you want to unsketch

redraw (boolean) – Optional. If model should be redrawn or not after the nodal rigid bodys 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 nodal rigid bodys flagged with flag in model m:
Oasys.PRIMER.NodalRigidBody.UnsketchAll(m, flag)

Instance methods¶

NodalRigidBody.AssociateComment(comment)¶
Associates a comment with a nodal rigid body

Parameters:

comment (Comment) – Comment that will be attached to the nodal rigid body

Returns:

No return value

Return type:

None

Example

To associate comment c to the nodal rigid body nrb:
nrb.AssociateComment(c)
NodalRigidBody.Blank()¶
Blanks the nodal rigid body

Returns:

No return value

Return type:

None

Example

To blank nodal rigid body nrb:
nrb.Blank()
NodalRigidBody.Blanked()¶
Checks if the nodal rigid body is blanked or not

Returns:

True if blanked, False if not

Return type:

bool

Example

To check if nodal rigid body nrb is blanked:
if nrb.Blanked():
    do_something..
NodalRigidBody.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 nodal rigid body nrb:
nrb.Browse()
NodalRigidBody.ClearFlag(flag)¶
Clears a flag on the nodal rigid body

Parameters:

flag (Flag) – Flag to clear on the nodal rigid body

Returns:

No return value

Return type:

None

Example

To clear flag f for nodal rigid body nrb:
nrb.ClearFlag(f)
NodalRigidBody.Copy(range=Oasys.gRPC.defaultArg)¶
Copies the nodal rigid body. The target include of the copied nodal rigid body 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:

NodalRigidBody object

Return type:

NodalRigidBody

Example

To copy nodal rigid body nrb into nodal rigid body z:
z = nrb.Copy()
NodalRigidBody.DetachComment(comment)¶
Detaches a comment from a nodal rigid body

Parameters:

comment (Comment) – Comment that will be detached from the nodal rigid body

Returns:

No return value

Return type:

None

Example

To detach comment c from the nodal rigid body nrb:
nrb.DetachComment(c)
NodalRigidBody.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 nodal rigid body nrb:
nrb.Edit()
NodalRigidBody.ExtractColour()¶
Extracts the actual colour used for nodal rigid body.
By default in PRIMER many entities such as elements get their colour automatically from the part that they are in. PRIMER cycles through 13 default colours based on the label of the entity. In this case the nodal rigid body colour property will return the value Colour.PART instead of the actual colour. This method will return the actual colour which is used for drawing the nodal rigid body

Returns:

colour value (integer)

Return type:

int

Example

To return the colour used for drawing nodal rigid body nrb:
colour = nrb.ExtractColour()
NodalRigidBody.Flagged(flag)¶
Checks if the nodal rigid body is flagged or not

Parameters:

flag (Flag) – Flag to test on the nodal rigid body

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if nodal rigid body nrb has flag f set on it:
if nrb.Flagged(f):
    do_something..
NodalRigidBody.GetComments()¶
Extracts the comments associated to a nodal rigid body

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 nodal rigid body nrb:
comm_list = nrb.GetComments()
NodalRigidBody.GetParameter(prop)¶
Checks if a NodalRigidBody 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 NodalRigidBody.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

prop (string) – nodal rigid body property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

To check if NodalRigidBody property nrb.example is a parameter:
Oasys.PRIMER.Options.property_parameter_names = True
if nrb.GetParameter(nrb.example):
    do_something...
Oasys.PRIMER.Options.property_parameter_names = False
To check if NodalRigidBody property nrb.example is a parameter by using the GetParameter method:
if nrb.ViewParameters().GetParameter(nrb.example):
    do_something..
NodalRigidBody.Keyword()¶
Returns the keyword for this nrb (*CONSTRAINED_NODAL_RIGID_BODY_xxxx). Note that a carriage return is not added. See also NodalRigidBody.KeywordCards()

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for nrb n:
key = n.Keyword()
NodalRigidBody.KeywordCards()¶
Returns the keyword cards for the nrb. Note that a carriage return is not added. See also NodalRigidBody.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for nrb n:
cards = n.KeywordCards()
NodalRigidBody.Next()¶
Returns the next nodal rigid body in the model

Returns:

NodalRigidBody object (or None if there are no more nodal rigid bodys in the model)

Return type:

NodalRigidBody

Example

To get the nodal rigid body in model m after nodal rigid body nrb:
nrb = nrb.Next()
NodalRigidBody.Previous()¶
Returns the previous nodal rigid body in the model

Returns:

NodalRigidBody object (or None if there are no more nodal rigid bodys in the model)

Return type:

NodalRigidBody

Example

To get the nodal rigid body in model m before nodal rigid body nrb:
nrb = nrb.Previous()
NodalRigidBody.SetFlag(flag)¶
Sets a flag on the nodal rigid body

Parameters:

flag (Flag) – Flag to set on the nodal rigid body

Returns:

No return value

Return type:

None

Example

To set flag f for nodal rigid body nrb:
nrb.SetFlag(f)
NodalRigidBody.Sketch(redraw=Oasys.gRPC.defaultArg)¶
Sketches the nodal rigid body. The nodal rigid body will be sketched until you either call NodalRigidBody.Unsketch(), NodalRigidBody.UnsketchAll(), Model.UnsketchAll(), or delete the model

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the nodal rigid body is sketched. If omitted redraw is true. If you want to sketch several nodal rigid bodys 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 nodal rigid body nrb:
nrb.Sketch()
NodalRigidBody.Unblank()¶
Unblanks the nodal rigid body

Returns:

No return value

Return type:

None

Example

To unblank nodal rigid body nrb:
nrb.Unblank()
NodalRigidBody.Unsketch(redraw=Oasys.gRPC.defaultArg)¶
Unsketches the nodal rigid body

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the nodal rigid body is unsketched. If omitted redraw is true. If you want to unsketch several nodal rigid bodys 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 nodal rigid body nrb:
nrb.Unsketch()
NodalRigidBody.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:

NodalRigidBody object

Return type:

dict

Example

To check if NodalRigidBody property nrb.example is a parameter by using the NodalRigidBody.GetParameter() method:
if nrb.ViewParameters().GetParameter(nrb.example):
    do_something..
NodalRigidBody.Xrefs()¶
Returns the cross references for this nodal rigid body

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for nodal rigid body nrb:
xrefs = nrb.Xrefs()