Oasys.PRIMER.InterfaceLinkingEdge class¶

Properties¶

property InterfaceLinkingEdge.exists(read only): boolean¶

true if Interface Linking Edge exists, false if referred to but not defined

property InterfaceLinkingEdge.ifid: integer¶

Interface ID

property InterfaceLinkingEdge.include: integer¶

The Include file number that the Interface Linking Edge is in

property InterfaceLinkingEdge.model(read only): integer¶

The Model number that the Interface Linking Edge is in

property InterfaceLinkingEdge.nsid: integer¶

Node set ID

Constructor¶

classmethod InterfaceLinkingEdge(model, nsid, ifid)¶
Create a new InterfaceLinkingEdge object

Parameters:

model (Model) – Model that Interface Linking Edge will be created in

nsid (integer) – Node set ID

ifid (integer) – Interface ID

Returns:

InterfaceLinkingEdge object

Return type:

dict

Example

To create a new Interface Linking Edge in model m with NSID 900 and IFID 2
b = Oasys.PRIMER.InterfaceLinkingEdge(m, 900, 2)

Static methods¶

classmethod InterfaceLinkingEdge.First(model)¶
Returns the first Interface Linking Edge in the model

Parameters:

model (Model) – Model to get first Interface Linking Edge in

Returns:

InterfaceLinkingEdge object (or None if there are no Interface Linking Edges in the model)

Return type:

InterfaceLinkingEdge

Example

To get the first Interface Linking Edge in model m:
I_LE = Oasys.PRIMER.InterfaceLinkingEdge.First(m)
classmethod InterfaceLinkingEdge.FlagAll(model, flag)¶
Flags all of the Interface Linking Edges in the model with a defined flag

Parameters:

model (Model) – Model that all Interface Linking Edges will be flagged in

flag (Flag) – Flag to set on the Interface Linking Edges

Returns:

No return value

Return type:

None

Example

To flag all of the Interface Linking Edges with flag f in model m:
Oasys.PRIMER.InterfaceLinkingEdge.FlagAll(m, f)
classmethod InterfaceLinkingEdge.GetAll(model)¶
Returns a list of InterfaceLinkingEdge objects for all of the Interface Linking Edges in a model in PRIMER

Parameters:

model (Model) – Model to get Interface Linking Edges from

Returns:

List of InterfaceLinkingEdge objects

Return type:

list

Example

To make a list of InterfaceLinkingEdge objects for all of the Interface Linking Edges in model m
I_LE = Oasys.PRIMER.InterfaceLinkingEdge.GetAll(m)
classmethod InterfaceLinkingEdge.GetFlagged(model, flag)¶
Returns a list of InterfaceLinkingEdge objects for all of the flagged Interface Linking Edges in a model in PRIMER

Parameters:

model (Model) – Model to get Interface Linking Edges from

flag (Flag) – Flag set on the Interface Linking Edges that you want to retrieve

Returns:

List of InterfaceLinkingEdge objects

Return type:

list

Example

To make a list of InterfaceLinkingEdge objects for all of the Interface Linking Edges in model m flagged with f
I_LE = Oasys.PRIMER.InterfaceLinkingEdge.GetFlagged(m, f)
classmethod InterfaceLinkingEdge.GetFromID(model, number)¶
Returns the InterfaceLinkingEdge object for a Interface Linking Edge ID

Parameters:

model (Model) – Model to find the Interface Linking Edge in

number (integer) – number of the Interface Linking Edge you want the InterfaceLinkingEdge object for

Returns:

InterfaceLinkingEdge object (or None if Interface Linking Edge does not exist)

Return type:

InterfaceLinkingEdge

Example

To get the InterfaceLinkingEdge object for Interface Linking Edge 100 in model m
I_LE = Oasys.PRIMER.InterfaceLinkingEdge.GetFromID(m, 100)
classmethod InterfaceLinkingEdge.Last(model)¶
Returns the last Interface Linking Edge in the model

Parameters:

model (Model) – Model to get last Interface Linking Edge in

Returns:

InterfaceLinkingEdge object (or None if there are no Interface Linking Edges in the model)

Return type:

InterfaceLinkingEdge

Example

To get the last Interface Linking Edge in model m:
I_LE = Oasys.PRIMER.InterfaceLinkingEdge.Last(m)
classmethod InterfaceLinkingEdge.Select(flag, prompt, limit=Oasys.gRPC.defaultArg, modal=Oasys.gRPC.defaultArg)¶
Allows the user to select Interface Linking Edges using standard PRIMER object menus

Parameters:

flag (Flag) – Flag to use when selecting Interface Linking Edges

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

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

Return type:

int

Example

To select Interface Linking Edges from model m, flagging those selected with flag f, giving the prompt ‘Select Interface Linking Edges’:
Oasys.PRIMER.InterfaceLinkingEdge.Select(f, 'Select Interface Linking Edges', m)
To select Interface Linking Edges, flagging those selected with flag f but limiting selection to Interface Linking Edges flagged with flag l, giving the prompt ‘Select Interface Linking Edges’:
Oasys.PRIMER.InterfaceLinkingEdge.Select(f, 'Select Interface Linking Edges', l)
classmethod InterfaceLinkingEdge.Total(model, exists=Oasys.gRPC.defaultArg)¶
Returns the total number of Interface Linking Edges in the model

Parameters:

model (Model) – Model to get total for

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

Returns:

number of Interface Linking Edges

Return type:

int

Example

To get the total number of Interface Linking Edges in model m:
total = Oasys.PRIMER.InterfaceLinkingEdge.Total(m)
classmethod InterfaceLinkingEdge.UnflagAll(model, flag)¶
Unsets a defined flag on all of the Interface Linking Edges in the model

Parameters:

model (Model) – Model that the defined flag for all Interface Linking Edges will be unset in

flag (Flag) – Flag to unset on the Interface Linking Edges

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the Interface Linking Edges in model m:
Oasys.PRIMER.InterfaceLinkingEdge.UnflagAll(m, f)

Instance methods¶

InterfaceLinkingEdge.AssociateComment(comment)¶
Associates a comment with a Interface Linking Edge

Parameters:

comment (Comment) – Comment that will be attached to the Interface Linking Edge

Returns:

No return value

Return type:

None

Example

To associate comment c to the Interface Linking Edge I_LE:
I_LE.AssociateComment(c)
InterfaceLinkingEdge.ClearFlag(flag)¶
Clears a flag on the Interface Linking Edge

Parameters:

flag (Flag) – Flag to clear on the Interface Linking Edge

Returns:

No return value

Return type:

None

Example

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

InterfaceLinkingEdge object

Return type:

InterfaceLinkingEdge

Example

To copy Interface Linking Edge I_LE into Interface Linking Edge z:
z = I_LE.Copy()
InterfaceLinkingEdge.DetachComment(comment)¶
Detaches a comment from a Interface Linking Edge

Parameters:

comment (Comment) – Comment that will be detached from the Interface Linking Edge

Returns:

No return value

Return type:

None

Example

To detach comment c from the Interface Linking Edge I_LE:
I_LE.DetachComment(c)
InterfaceLinkingEdge.Flagged(flag)¶
Checks if the Interface Linking Edge is flagged or not

Parameters:

flag (Flag) – Flag to test on the Interface Linking Edge

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if Interface Linking Edge I_LE has flag f set on it:
if I_LE.Flagged(f):
    do_something..
InterfaceLinkingEdge.GetComments()¶
Extracts the comments associated to a Interface Linking Edge

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

Parameters:

prop (string) – Interface Linking Edge property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

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

Returns:

string containing the keyword

Return type:

str

Example

To get the keyword for Interface Linking Edge m:
key = m.Keyword()
InterfaceLinkingEdge.KeywordCards()¶
Returns the keyword cards for the Interface Linking Edge. Note that a carriage return is not added. See also InterfaceLinkingEdge.Keyword()

Returns:

string containing the cards

Return type:

str

Example

To get the cards for Interface Linking Edge l:
cards = l.KeywordCards()
InterfaceLinkingEdge.Next()¶
Returns the next Interface Linking Edge in the model

Returns:

InterfaceLinkingEdge object (or None if there are no more Interface Linking Edges in the model)

Return type:

InterfaceLinkingEdge

Example

To get the Interface Linking Edge in model m after Interface Linking Edge I_LE:
I_LE = I_LE.Next()
InterfaceLinkingEdge.Previous()¶
Returns the previous Interface Linking Edge in the model

Returns:

InterfaceLinkingEdge object (or None if there are no more Interface Linking Edges in the model)

Return type:

InterfaceLinkingEdge

Example

To get the Interface Linking Edge in model m before Interface Linking Edge I_LE:
I_LE = I_LE.Previous()
InterfaceLinkingEdge.SetFlag(flag)¶
Sets a flag on the Interface Linking Edge

Parameters:

flag (Flag) – Flag to set on the Interface Linking Edge

Returns:

No return value

Return type:

None

Example

To set flag f for Interface Linking Edge I_LE:
I_LE.SetFlag(f)
InterfaceLinkingEdge.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:

InterfaceLinkingEdge object

Return type:

dict

Example

To check if InterfaceLinkingEdge property I_LE.example is a parameter by using the InterfaceLinkingEdge.GetParameter() method:
if I_LE.ViewParameters().GetParameter(I_LE.example):
    do_something..
InterfaceLinkingEdge.Xrefs()¶
Returns the cross references for this Interface Linking Edge

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for Interface Linking Edge I_LE:
xrefs = I_LE.Xrefs()