Python reference: ObjectExtra

The class ObjectExtra represents the C API structure TObjectExtra2. See the documentation on this function for the values required for the ObjectExtra attributes.

Construction

The Python interface provides the following functions to return instances of ObjectExtra.

The following functions are for objects requiring position data. Here pos is three numeric values (e.g. oeBuoy(0.0, 1.0, 1.3)) or an iterable of three values (e.g. oeBuoy([0.0, 1.0, 1.3])):

Object extra functions for lines are below. Use the oeLine() function if the attribute you need to set is not covered by one of the more specific line object extra functions. Set the attributes you require by name, e.g. oeLine(Theta=45.0, ArcLength=56.0). Attributes not set take the default values shown below:

Object extra functions for other OrcaFlex object types:

For line supports results:

For turbine results:

For Morison element results:

For vessel air gap results:

Attributes

The attributes are the same as in TObjectExtra2 and take the same values.

• EnvironmentPos
• LinePoint
• NodeNum
• ArcLength
• RadialPos
• Theta
• WingName
• ClearanceLineName
• WinchConnectionPoint
• RigidBodyPos
• ExternalResultText
• DisturbanceVesselName
• SupportIndex
• SupportedLineName
• BladeIndex
• ElementIndex
• SeaSurfaceScalingFactor

Sometimes you need to specify a combination of these attributes for which none of the functions above suffices. In that case, use the function above that most closely matches your needs, and then set the additional attributes. For example: