Oasys.PRIMER.IGAEdgeUVW class¶

Constants¶

IGAEdgeUVW.BASIS_TRANSFORM¶

BASIS_TRANSFORM is *IGA_EDGE_UVW_BASIS_TRANSFORM

IGAEdgeUVW.NONE¶

NONE is *IGA_EDGE_UVW

Properties¶

property IGAEdgeUVW.edgeid: integer¶

Parametric Edge ID

property IGAEdgeUVW.eid: integer¶

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

property IGAEdgeUVW.elid: integer¶

Element ID local to a basis transform

property IGAEdgeUVW.exists(read only): boolean¶

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

property IGAEdgeUVW.exyzid: integer¶

Physical edge ID. *IGA_EDGE_XYZ

property IGAEdgeUVW.include: integer¶

The Include file number that the IGA Edge UVW is in

property IGAEdgeUVW.label: integer¶

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

property IGAEdgeUVW.model(read only): integer¶

The Model number that the IGA Edge UVW is in

property IGAEdgeUVW.option: constant¶

IGA Edge UVW option. IGAEdgeUVW.NONE or IGAEdgeUVW.BASIS_TRANSFORM

property IGAEdgeUVW.patchid: integer¶

Parametric univariate NURBS patch ID

property IGAEdgeUVW.rend: float¶

Parametric coordinate defining the end of the trimmed parametric NURBS

property IGAEdgeUVW.rstart: float¶

Parametric coordinate defining the start of the trimmed parametric NURBS

property IGAEdgeUVW.sense: integer¶

Sense of orientation with respect to the physical edge

Constructor¶

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

Parameters:

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

details (dict) –
Details for creating the IGAEdgeUVW

edgeid (optional):

(integer) Parametric Edge ID

eid:

(integer) ID of the IGA Edge UVW

elid (optional):

(integer) Element ID local to a basis transform

exyzid (optional):

(integer) Physical edge ID. *IGA_EDGE_XYZ

option (optional):

(constant) IGA Edge UVW option. IGAEdgeUVW.NONE or IGAEdgeUVW.BASIS_TRANSFORM

patchid (optional):

(integer) Parametric univariate NURBS patch ID

rend (optional):

(float) Parametric coordinate defining the end of the trimmed parametric NURBS

rstart (optional):

(float) Parametric coordinate defining the start of the trimmed parametric NURBS

sense (optional):

(integer) Sense of orientation with respect to the physical edge

Returns:

IGAEdgeUVW object

Return type:

IGAEdgeUVW

Example

To create a new IGA edge uvw in model m using eid 10:
igeu = Oasys.PRIMER.IGAEdgeUVW((m, {'eid': 10})
To create a new IGA edge uvw in model m using eid 21 and option BASIS_TRANSFORM with exyzid 22, elid 31 and edgeid as 32:
igeu = Oasys.PRIMER.IGAEdgeUVW((m, {'option':Oasys.PRIMER.IGAEdgeUVW.BASIS_TRANSFORM, 'eid': 21, 'exyzid': 22, 'elid': 31, 'edgeid': 32})

Static methods¶

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

Parameters:

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

IGAEdgeUVW object (or None if not made)

Return type:

IGAEdgeUVW

Example

To start creating a IGA Edge UVW in model m:
igeu = Oasys.PRIMER.IGAEdgeUVW.Create(m)
classmethod IGAEdgeUVW.First(model)¶
Returns the first IGA Edge UVW in the model

Parameters:

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

Returns:

IGAEdgeUVW object (or None if there are no IGA Edge UVWs in the model)

Return type:

IGAEdgeUVW

Example

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

Parameters:

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

IGAEdgeUVW label

Return type:

int

Example

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

Parameters:

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

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

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

Returns:

List of IGAEdgeUVW objects or properties

Return type:

list

Example

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

Parameters:

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

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

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

Returns:

List of IGAEdgeUVW objects or properties

Return type:

list

Example

To make a list of IGAEdgeUVW objects for all of the IGA Edge UVWs in model m flagged with f:
igeu = Oasys.PRIMER.IGAEdgeUVW.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 UVWs in model m flagged with f:
a = Oasys.PRIMER.IGAEdgeUVW.GetFlagged(m, f, 'foo')
classmethod IGAEdgeUVW.GetFromID(model, number)¶
Returns the IGAEdgeUVW object for a IGA Edge UVW ID

Parameters:

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

number (integer) – number of the IGA Edge UVW you want the IGAEdgeUVW object for

Returns:

IGAEdgeUVW object (or None if IGA Edge UVW does not exist)

Return type:

IGAEdgeUVW

Example

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

Parameters:

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

Returns:

IGAEdgeUVW object (or None if there are no IGA Edge UVWs in the model)

Return type:

IGAEdgeUVW

Example

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

Parameters:

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

IGAEdgeUVW label

Return type:

int

Example

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

Parameters:

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

IGAEdgeUVW label

Return type:

int

Example

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

Parameters:

model (Model) – Model that all IGA Edge UVWs 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 UVWs in model m, from 1000000:
Oasys.PRIMER.IGAEdgeUVW.RenumberAll(m, 1000000)
classmethod IGAEdgeUVW.RenumberFlagged(model, flag, start)¶
Renumbers all of the flagged IGA Edge UVWs in the model

Parameters:

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

flag (Flag) – Flag set on the IGA Edge UVWs 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 UVWs in model m flagged with f, from 1000000:
Oasys.PRIMER.IGAEdgeUVW.RenumberFlagged(m, f, 1000000)
classmethod IGAEdgeUVW.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select IGA Edge UVWs using standard PRIMER object menus

Parameters:

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

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

Return type:

int

Example

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

Parameters:

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

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

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

Parameters:

model (Model) – Model to get total for

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

Returns:

number of IGA Edge UVWs

Return type:

int

Example

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

Parameters:

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

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

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

Parameters:

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

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

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

Instance methods¶

IGAEdgeUVW.AssociateComment(comment)¶
Associates a comment with a IGA Edge UVW

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

IGAEdgeUVW object

Return type:

IGAEdgeUVW

Example

To copy IGA Edge UVW igeu into IGA Edge UVW z:
z = igeu.Copy()
IGAEdgeUVW.DetachComment(comment)¶
Detaches a comment from a IGA Edge UVW

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Returns:

True if flagged, False if not

Return type:

bool

Example

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

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 UVW igeu:
comm_list = igeu.GetComments()
IGAEdgeUVW.GetParameter(prop)¶
Checks if a IGAEdgeUVW 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 IGAEdgeUVW.ViewParameters() method and ‘method chaining’ (see the examples below)

Parameters:

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

Returns:

Parameter object if property is a parameter, None if not

Return type:

Parameter

Example

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

Returns:

string containing the keyword

Return type:

str

Example

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

Returns:

string containing the cards

Return type:

str

Example

To get the cards for IGA edge uvw igeu:
cards = igeu.KeywordCards()
IGAEdgeUVW.Next()¶
Returns the next IGA Edge UVW in the model

Returns:

IGAEdgeUVW object (or None if there are no more IGA Edge UVWs in the model)

Return type:

IGAEdgeUVW

Example

To get the IGA Edge UVW in model m after IGA Edge UVW igeu:
igeu = igeu.Next()
IGAEdgeUVW.Previous()¶
Returns the previous IGA Edge UVW in the model

Returns:

IGAEdgeUVW object (or None if there are no more IGA Edge UVWs in the model)

Return type:

IGAEdgeUVW

Example

To get the IGA Edge UVW in model m before IGA Edge UVW igeu:
igeu = igeu.Previous()
IGAEdgeUVW.SetFlag(flag)¶
Sets a flag on the IGA Edge UVW

Parameters:

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

Returns:

No return value

Return type:

None

Example

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

Parameters:

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

Parameters:

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

IGAEdgeUVW object

Return type:

IGAEdgeUVW

Example

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

Returns:

Xrefs object

Return type:

Xrefs

Example

To get the cross references for IGA Edge UVW igeu:
xrefs = igeu.Xrefs()