Oasys.PRIMER.IGAEdgeXYZ class¶

Properties¶

property IGAEdgeXYZ.eid: integer¶

IGAEdgeXYZ number. Also see the label property which is an alternative name for this

property IGAEdgeXYZ.exists(read only): boolean¶

true if IGA Edge XYZ exists, false if referred to but not defined

property IGAEdgeXYZ.include: integer¶

The Include file number that the IGA Edge XYZ is in

property IGAEdgeXYZ.label: integer¶

IGAEdgeXYZ number. Also see the eid property which is an alternative name for this

property IGAEdgeXYZ.model(read only): integer¶

The Model number that the IGA Edge XYZ is in

property IGAEdgeXYZ.ori: integer¶

Orientation with respect to the physical univariate NURBS

property IGAEdgeXYZ.patchid: integer¶

Physical univariate NURBS patch ID

property IGAEdgeXYZ.pidend: integer¶

Parametric point ID defining the end of the trimmed physical NURBS

property IGAEdgeXYZ.pidstart: integer¶

Parametric point ID defining the start of the trimmed physical NURBS

property IGAEdgeXYZ.psid: integer¶

Parametric point set ID. *SET_IGA_POINT_UVW

Constructor¶

classmethod IGAEdgeXYZ(model, details)¶
Create a new IGAEdgeXYZ object

Parameters:

model (Model) – Model that IGA edge xyz will be created in

details (dict) –
Details for creating the IGAEdgeXYZ

eid:

(integer) ID of the IGA Edge XYZ

ori (optional):

(integer) Orientation with respect to the physical univariate NURBS

patchid (optional):

(integer) Physical univariate NURBS patch ID

pidend (optional):

(integer) Parametric point ID defining the end of the trimmed physical NURBS

pidstart (optional):

(integer) Parametric point ID defining the start of the trimmed physical NURBS

psid (optional):

(integer) Parametric point set ID. *SET_IGA_POINT_UVW

Returns:

IGAEdgeXYZ object

Return type:

IGAEdgeXYZ

Example

To create a new IGA edge xyz in model m using eid 10:
igex = Oasys.PRIMER.IGAEdgeXYZ((m, {'eid': 10})
To create a new IGA edge xyz in model m using eid 21 with patch id 22, ori as 23, pidstart as 24, pidend as 25 and psid as 26:
igex = Oasys.PRIMER.IGAEdgeXYZ((m, {'eid': 21, 'patchid': 22, 'ori': 23, 'pidstart': 24,, 'pidend': 25, 'psid': 26})

Static methods¶

classmethod IGAEdgeXYZ.Create(model, modal=Oasys.gRPC.defaultArg)¶
Starts an interactive editing panel to create a IGA Edge XYZ

Parameters:

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

IGAEdgeXYZ object (or None if not made)

Return type:

IGAEdgeXYZ

Example

To start creating a IGA Edge XYZ in model m:
igex = Oasys.PRIMER.IGAEdgeXYZ.Create(m)
classmethod IGAEdgeXYZ.First(model)¶
Returns the first IGA Edge XYZ in the model

Parameters:

model (Model) – Model to get first IGA Edge XYZ in

Returns:

IGAEdgeXYZ object (or None if there are no IGA Edge XYZs in the model)

Return type:

IGAEdgeXYZ

Example

To get the first IGA Edge XYZ in model m:
igex = Oasys.PRIMER.IGAEdgeXYZ.First(m)
classmethod IGAEdgeXYZ.FirstFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the first free IGA Edge XYZ label in the model. Also see IGAEdgeXYZ.LastFreeLabel(), IGAEdgeXYZ.NextFreeLabel() and Model.FirstFreeItemLabel()

Parameters:

model (Model) – Model to get first free IGA Edge XYZ 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:

IGAEdgeXYZ label

Return type:

int

Example

To get the first free IGA Edge XYZ label in model m:
label = Oasys.PRIMER.IGAEdgeXYZ.FirstFreeLabel(m)
classmethod IGAEdgeXYZ.FlagAll(model, flag)¶
Flags all of the IGA Edge XYZs in the model with a defined flag

Parameters:

model (Model) – Model that all IGA Edge XYZs will be flagged in

flag (Flag) – Flag to set on the IGA Edge XYZs

Returns:

No return value

Return type:

None

Example

To flag all of the IGA Edge XYZs with flag f in model m:
Oasys.PRIMER.IGAEdgeXYZ.FlagAll(m, f)
classmethod IGAEdgeXYZ.GetAll(model, property=Oasys.gRPC.defaultArg)¶
Returns a list of IGAEdgeXYZ objects or properties for all of the IGA Edge XYZs in a model in PRIMER. If the optional property argument is not given then a list of IGAEdgeXYZ objects is returned. If the property argument is given, that property value for each IGA Edge XYZ is returned in the list instead of a IGAEdgeXYZ object

Parameters:

model (Model) – Model to get IGA Edge XYZs from

property (string) – Optional. Name for property to get for all IGA Edge XYZs in the model

Returns:

List of IGAEdgeXYZ objects or properties

Return type:

list

Example

To make a list of IGAEdgeXYZ objects for all of the IGA Edge XYZs in model m:
a = Oasys.PRIMER.IGAEdgeXYZ.GetAll(m)
To return a list containing the value of property ‘foo’ (for example ‘x’ for a node) for each IGA Edge XYZ in model m:
a = Oasys.PRIMER.IGAEdgeXYZ.GetAll(m, 'foo')
classmethod IGAEdgeXYZ.GetFlagged(model, flag, property=Oasys.gRPC.defaultArg)¶
Returns a list of IGAEdgeXYZ objects for all of the flagged IGA Edge XYZs in a model in PRIMER If the optional property argument is not given then a list of IGAEdgeXYZ objects is returned. If the property argument is given, then that property value for each IGA Edge XYZ is returned in the list instead of a IGAEdgeXYZ object

Parameters:

model (Model) – Model to get IGA Edge XYZs from

flag (Flag) – Flag set on the IGA Edge XYZs that you want to retrieve

property (string) – Optional. Name for property to get for all flagged IGA Edge XYZs in the model

Returns:

List of IGAEdgeXYZ objects or properties

Return type:

list

Example

To make a list of IGAEdgeXYZ objects for all of the IGA Edge XYZs in model m flagged with f:
igex = Oasys.PRIMER.IGAEdgeXYZ.GetFlagged(m, f)
To return a list containing the value of property ‘foo’ (for example ‘x’ for a node) for all of the IGA Edge XYZs in model m flagged with f:
a = Oasys.PRIMER.IGAEdgeXYZ.GetFlagged(m, f, 'foo')
classmethod IGAEdgeXYZ.GetFromID(model, number)¶
Returns the IGAEdgeXYZ object for a IGA Edge XYZ ID

Parameters:

model (Model) – Model to find the IGA Edge XYZ in

number (integer) – number of the IGA Edge XYZ you want the IGAEdgeXYZ object for

Returns:

IGAEdgeXYZ object (or None if IGA Edge XYZ does not exist)

Return type:

IGAEdgeXYZ

Example

To get the IGAEdgeXYZ object for IGA Edge XYZ 100 in model m
igex = Oasys.PRIMER.IGAEdgeXYZ.GetFromID(m, 100)
classmethod IGAEdgeXYZ.Last(model)¶
Returns the last IGA Edge XYZ in the model

Parameters:

model (Model) – Model to get last IGA Edge XYZ in

Returns:

IGAEdgeXYZ object (or None if there are no IGA Edge XYZs in the model)

Return type:

IGAEdgeXYZ

Example

To get the last IGA Edge XYZ in model m:
igex = Oasys.PRIMER.IGAEdgeXYZ.Last(m)
classmethod IGAEdgeXYZ.LastFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the last free IGA Edge XYZ label in the model. Also see IGAEdgeXYZ.FirstFreeLabel(), IGAEdgeXYZ.NextFreeLabel() and see Model.LastFreeItemLabel()

Parameters:

model (Model) – Model to get last free IGA Edge XYZ 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:

IGAEdgeXYZ label

Return type:

int

Example

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

Parameters:

model (Model) – Model to get next free IGA Edge XYZ 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:

IGAEdgeXYZ label

Return type:

int

Example

To get the next free IGA Edge XYZ label in model m:
label = Oasys.PRIMER.IGAEdgeXYZ.NextFreeLabel(m)
classmethod IGAEdgeXYZ.RenumberAll(model, start)¶
Renumbers all of the IGA Edge XYZs in the model

Parameters:

model (Model) – Model that all IGA Edge XYZs will be renumbered in

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the IGA Edge XYZs in model m, from 1000000:
Oasys.PRIMER.IGAEdgeXYZ.RenumberAll(m, 1000000)
classmethod IGAEdgeXYZ.RenumberFlagged(model, flag, start)¶
Renumbers all of the flagged IGA Edge XYZs in the model

Parameters:

model (Model) – Model that all the flagged IGA Edge XYZs will be renumbered in

flag (Flag) – Flag set on the IGA Edge XYZs that you want to renumber

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

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

Parameters:

flag (Flag) – Flag to use when selecting IGA Edge XYZs

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

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

Return type:

int

Example

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

Parameters:

model (Model) – Model that all the flagged IGA Edge XYZs will be sketched in

flag (Flag) – Flag set on the IGA Edge XYZs that you want to sketch

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

Parameters:

model (Model) – Model to get total for

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

Returns:

number of IGA Edge XYZs

Return type:

int

Example

To get the total number of IGA Edge XYZs in model m:
total = Oasys.PRIMER.IGAEdgeXYZ.Total(m)
classmethod IGAEdgeXYZ.UnflagAll(model, flag)¶
Unsets a defined flag on all of the IGA Edge XYZs in the model

Parameters:

model (Model) – Model that the defined flag for all IGA Edge XYZs will be unset in

flag (Flag) – Flag to unset on the IGA Edge XYZs

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the IGA Edge XYZs in model m:
Oasys.PRIMER.IGAEdgeXYZ.UnflagAll(m, f)
classmethod IGAEdgeXYZ.UnsketchAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all IGA Edge XYZs

Parameters:

model (Model) – Model that all IGA Edge XYZs will be unblanked in

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

Parameters:

model (Model) – Model that all IGA Edge XYZs will be unsketched in

flag (Flag) – Flag set on the IGA Edge XYZs that you want to unsketch

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

Instance methods¶

IGAEdgeXYZ.AssociateComment(comment)¶
Associates a comment with a IGA Edge XYZ

Parameters:

comment (Comment) – Comment that will be attached to the IGA Edge XYZ

Returns:

No return value

Return type:

None

Example

To associate comment c to the IGA Edge XYZ igex:
igex.AssociateComment(c)
IGAEdgeXYZ.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 IGA Edge XYZ igex:
igex.Browse()
IGAEdgeXYZ.ClearFlag(flag)¶
Clears a flag on the IGA Edge XYZ

Parameters:

flag (Flag) – Flag to clear on the IGA Edge XYZ

Returns:

No return value

Return type:

None

Example

To clear flag f for IGA Edge XYZ igex:
igex.ClearFlag(f)
IGAEdgeXYZ.Copy(range=Oasys.gRPC.defaultArg)¶
Copies the IGA Edge XYZ. The target include of the copied IGA Edge XYZ 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:

IGAEdgeXYZ object

Return type:

IGAEdgeXYZ

Example

To copy IGA Edge XYZ igex into IGA Edge XYZ z:
z = igex.Copy()
IGAEdgeXYZ.DetachComment(comment)¶
Detaches a comment from a IGA Edge XYZ

Parameters:

comment (Comment) – Comment that will be detached from the IGA Edge XYZ

Returns:

No return value

Return type:

None

Example

To detach comment c from the IGA Edge XYZ igex:
igex.DetachComment(c)
IGAEdgeXYZ.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 IGA Edge XYZ igex:
igex.Edit()
IGAEdgeXYZ.Flagged(flag)¶
Checks if the IGA Edge XYZ is flagged or not

Parameters:

flag (Flag) – Flag to test on the IGA Edge XYZ

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if IGA Edge XYZ igex has flag f set on it:
if igex.Flagged(f):
    do_something..
IGAEdgeXYZ.GetComments()¶
Extracts the comments associated to a IGA Edge XYZ

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 IGA Edge XYZ igex:
comm_list = igex.GetComments()
IGAEdgeXYZ.GetParameter(prop)¶
Checks if a IGAEdgeXYZ 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 IGAEdgeXYZ.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

prop (string) – IGA Edge XYZ property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

Parameter

Example

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

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for IGA edge xyz igex:
key = igex.Keyword()
IGAEdgeXYZ.KeywordCards()¶
Returns the keyword cards for the IGA edge xyz. Note that a carriage return is not added. See also IGAEdgeXYZ.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for IGA edge xyz igex:
cards = igex.KeywordCards()
IGAEdgeXYZ.Next()¶
Returns the next IGA Edge XYZ in the model

Returns:

IGAEdgeXYZ object (or None if there are no more IGA Edge XYZs in the model)

Return type:

IGAEdgeXYZ

Example

To get the IGA Edge XYZ in model m after IGA Edge XYZ igex:
igex = igex.Next()
IGAEdgeXYZ.Previous()¶
Returns the previous IGA Edge XYZ in the model

Returns:

IGAEdgeXYZ object (or None if there are no more IGA Edge XYZs in the model)

Return type:

IGAEdgeXYZ

Example

To get the IGA Edge XYZ in model m before IGA Edge XYZ igex:
igex = igex.Previous()
IGAEdgeXYZ.SetFlag(flag)¶
Sets a flag on the IGA Edge XYZ

Parameters:

flag (Flag) – Flag to set on the IGA Edge XYZ

Returns:

No return value

Return type:

None

Example

To set flag f for IGA Edge XYZ igex:
igex.SetFlag(f)
IGAEdgeXYZ.Sketch(redraw=Oasys.gRPC.defaultArg)¶
Sketches the IGA Edge XYZ. The IGA Edge XYZ will be sketched until you either call IGAEdgeXYZ.Unsketch(), IGAEdgeXYZ.UnsketchAll(), Model.UnsketchAll(), or delete the model

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the IGA Edge XYZ is sketched. If omitted redraw is true. If you want to sketch several IGA Edge XYZs 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 IGA Edge XYZ igex:
igex.Sketch()
IGAEdgeXYZ.Unsketch(redraw=Oasys.gRPC.defaultArg)¶
Unsketches the IGA Edge XYZ

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the IGA Edge XYZ is unsketched. If omitted redraw is true. If you want to unsketch several IGA Edge XYZs 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 IGA Edge XYZ igex:
igex.Unsketch()
IGAEdgeXYZ.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:

IGAEdgeXYZ object

Return type:

IGAEdgeXYZ

Example

To check if IGAEdgeXYZ property igex.example is a parameter by using the IGAEdgeXYZ.GetParameter() method:
if igex.ViewParameters().GetParameter(igex.example):
    do_something..
IGAEdgeXYZ.Xrefs()¶
Returns the cross references for this IGA Edge XYZ

Returns:

Xrefs object

Return type:

Xrefs

Example

To get the cross references for IGA Edge XYZ igex:
xrefs = igex.Xrefs()