Oasys.PRIMER.CoordinateSystem class¶

Constants¶

CoordinateSystem.NODES¶

Csys is *DEFINE_COORDINATE_NODES

CoordinateSystem.SYSTEM¶

Csys is *DEFINE_COORDINATE_SYSTEM

CoordinateSystem.VECTOR¶

Csys is *DEFINE_COORDINATE_VECTOR

Properties¶

property CoordinateSystem.cid: integer¶

CoordinateSystem number. Also see the label number

property CoordinateSystem.cidl: integer¶

Optional local coordinate system to define the points in

property CoordinateSystem.dir: int¶

Axis defined by N1N2

property CoordinateSystem.exists(read only): boolean¶

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

property CoordinateSystem.flag: boolean¶

Flag for updating local system each timestep

property CoordinateSystem.heading: string¶

CoordinateSystem heading

property CoordinateSystem.include: integer¶

The Include file number that the csys is in

property CoordinateSystem.label: integer¶

CoordinateSystem number. Also see the cid property which is an alternative name for this

property CoordinateSystem.lx: float¶

X-coordinate of point on local X-axis

property CoordinateSystem.ly: float¶

Y-coordinate of point on local X-axis

property CoordinateSystem.lz: float¶

Z-coordinate of point on local X-axis

property CoordinateSystem.model(read only): integer¶

The Model number that the coordinate system is in

property CoordinateSystem.n1: int¶

Node located at local origin

property CoordinateSystem.n2: int¶

Node located along local (dir) axis

property CoordinateSystem.n3: int¶

Node located in local plane determined by (dir)

property CoordinateSystem.nid: integer¶

Optional node id for rotation

property CoordinateSystem.option: constant¶

CoordinateSystem type (Can be CoordinateSystem.NODES, CoordinateSystem.SYSTEM or CoordinateSystem.VECTOR)

property CoordinateSystem.ox: float¶

X-coordinate of origin

property CoordinateSystem.oy: float¶

Y-coordinate of origin

property CoordinateSystem.oz: float¶

Z-coordinate of origin

property CoordinateSystem.px: float¶

X-coordinate of point in local X-Y plane

property CoordinateSystem.py: float¶

Y-coordinate of point in local X-Y plane

property CoordinateSystem.pz: float¶

Z-coordinate of point in local X-Y plane

property CoordinateSystem.vx: float¶

X-coordinate of local X-Y vector

property CoordinateSystem.vy: float¶

Y-coordinate of local X-Y vector

property CoordinateSystem.vz: float¶

Z-coordinate of local X-Y vector

property CoordinateSystem.xx: float¶

X-coordinate on local X-axis

property CoordinateSystem.xy: float¶

Y-coordinate on local X-axis

property CoordinateSystem.xz: float¶

Z-coordinate on local X-axis

Constructor¶

classmethod CoordinateSystem(model, details)¶
Create a new CoordinateSystem object for *DEFINE_COORDINATE_NODES

Parameters:

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

details (dict) –
Details for creating the CoordinateSystem

cid:

(integer) Label of CoordinateSystem

cl (optional):

(array) List of coordinates of point on local X-axis [lx, ly, lz] (for option CoordinateSystem.SYSTEM)

co (optional):

(array) List of coordinates of origin [ox, oy, oz] (for option CoordinateSystem.SYSTEM)

cp (optional):

(array) List of coordinates of point in local X-Y plane [px, py, pz] (for option CoordinateSystem.SYSTEM)

cv (optional):

(array) List of coordinates of local X-Y vector [vx, vy, vz] (for option CoordinateSystem.VECTOR)

cx (optional):

(array) List of coordinates on local X-axis [xx, xy, xz] (for option CoordinateSystem.VECTOR)

dir (optional):

(integer) Axis defined by N1N2 (for option CoordinateSystem.NODES)

flag (optional):

(boolean) Flag for local system update for each time step (for option CoordinateSystem.NODES)

heading (optional):

(string) Title for the coordinate system

nid (optional):

(integer) Optional Node ID for rotation (for option CoordinateSystem.VECTOR)

nodes (optional):

(array) List of Node IDs [n1, n2, n3] for the coordinate system (for option CoordinateSystem.NODES)

option:

(constant) CoordinateSystem type (can be CoordinateSystem.NODES, CoordinateSystem.SYSTEM or CoordinateSystem.VECTOR)

Returns:

CoordinateSystem object

Return type:

dict

Example

To create a new Csys of type Nodes in model m with label 200 and title “Test csys 1” defined by nodes 1, 2, 3 with where N1N2 defines local Y-axis; local system update flag is off
c = Oasys.PRIMER.CoordinateSystem(m, {'option': Oasys.PRIMER.CoordinateSystem.NODES, 'cid': 200, 'nodes': [1, 2, 3], 'flag': 0, 'dir': 2, 'heading': 'Test csys nodes'})
To create a new Csys of type System in model m with label 300 and title “Test csys 2” with origin at (10, 10, 0), point on local X-axis at (20, 20, 0) and point in X-Y plane at (10, 20, 0)
c = Oasys.PRIMER.CoordinateSystem(m, {'option': Oasys.PRIMER.CoordinateSystem.SYSTEM, 'cid': 300, 'co': [10, 10, 0], 'cl': [20, 20, 0], 'cp': [10, 20, 0], 'heading': 'Test csys system'})
To create a new Csys of type Vector in model m with label 400 with point on local X-axis at (50, 50, 0) and local XY vector being (-10, -20, 0) that can rotate with node 10003
c = Oasys.PRIMER.CoordinateSystem(m, {'option': Oasys.PRIMER.CoordinateSystem.VECTOR, 'cid': 400, 'cx': [50, 50, 0], 'cv': [10, -20, 0], 'nid': 10003, 'heading': 'Test csys vector'})

Static methods¶

classmethod CoordinateSystem.BlankAll(model, redraw=Oasys.gRPC.defaultArg)¶
Blanks all of the coordinate systems in the model

Parameters:

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

Parameters:

model (Model) – Model that all the flagged coordinate systems will be blanked in

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

Parameters:

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

CoordinateSystem object (or None if not made)

Return type:

dict

Example

To start creating a csys in model m:
m = Oasys.PRIMER.CoordinateSystem.Create(m)
classmethod CoordinateSystem.First(model)¶
Returns the first coordinate system in the model

Parameters:

model (Model) – Model to get first coordinate system in

Returns:

CoordinateSystem object (or None if there are no coordinate systems in the model)

Return type:

CoordinateSystem

Example

To get the first coordinate system in model m:
c = Oasys.PRIMER.CoordinateSystem.First(m)
classmethod CoordinateSystem.FirstFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the first free coordinate system label in the model. Also see CoordinateSystem.LastFreeLabel(), CoordinateSystem.NextFreeLabel() and Model.FirstFreeItemLabel()

Parameters:

model (Model) – Model to get first free coordinate system 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:

CoordinateSystem label

Return type:

int

Example

To get the first free coordinate system label in model m:
label = Oasys.PRIMER.CoordinateSystem.FirstFreeLabel(m)
classmethod CoordinateSystem.FlagAll(model, flag)¶
Flags all of the coordinate systems in the model with a defined flag

Parameters:

model (Model) – Model that all coordinate systems will be flagged in

flag (Flag) – Flag to set on the coordinate systems

Returns:

No return value

Return type:

None

Example

To flag all of the coordinate systems with flag f in model m:
Oasys.PRIMER.CoordinateSystem.FlagAll(m, f)
classmethod CoordinateSystem.GetAll(model)¶
Returns a list of CoordinateSystem objects for all of the coordinate systems in a model in PRIMER

Parameters:

model (Model) – Model to get coordinate systems from

Returns:

List of CoordinateSystem objects

Return type:

list

Example

To make a list of CoordinateSystem objects for all of the coordinate systems in model m
c = Oasys.PRIMER.CoordinateSystem.GetAll(m)
classmethod CoordinateSystem.GetFlagged(model, flag)¶
Returns a list of CoordinateSystem objects for all of the flagged coordinate systems in a model in PRIMER

Parameters:

model (Model) – Model to get coordinate systems from

flag (Flag) – Flag set on the coordinate systems that you want to retrieve

Returns:

List of CoordinateSystem objects

Return type:

list

Example

To make a list of CoordinateSystem objects for all of the coordinate systems in model m flagged with f
c = Oasys.PRIMER.CoordinateSystem.GetFlagged(m, f)
classmethod CoordinateSystem.GetFromID(model, number)¶
Returns the CoordinateSystem object for a coordinate system ID

Parameters:

model (Model) – Model to find the coordinate system in

number (integer) – number of the coordinate system you want the CoordinateSystem object for

Returns:

CoordinateSystem object (or None if coordinate system does not exist)

Return type:

CoordinateSystem

Example

To get the CoordinateSystem object for coordinate system 100 in model m
c = Oasys.PRIMER.CoordinateSystem.GetFromID(m, 100)
classmethod CoordinateSystem.Last(model)¶
Returns the last coordinate system in the model

Parameters:

model (Model) – Model to get last coordinate system in

Returns:

CoordinateSystem object (or None if there are no coordinate systems in the model)

Return type:

CoordinateSystem

Example

To get the last coordinate system in model m:
c = Oasys.PRIMER.CoordinateSystem.Last(m)
classmethod CoordinateSystem.LastFreeLabel(model, layer=Oasys.gRPC.defaultArg)¶
Returns the last free coordinate system label in the model. Also see CoordinateSystem.FirstFreeLabel(), CoordinateSystem.NextFreeLabel() and see Model.LastFreeItemLabel()

Parameters:

model (Model) – Model to get last free coordinate system 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:

CoordinateSystem label

Return type:

int

Example

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

Parameters:

model (Model) – Model to get next free coordinate system 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:

CoordinateSystem label

Return type:

int

Example

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

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

CoordinateSystem object (or None if not picked)

Return type:

dict

Example

To pick a coordinate system from model m giving the prompt ‘Pick coordinate system from screen’:
c = Oasys.PRIMER.CoordinateSystem.Pick('Pick coordinate system from screen', m)
classmethod CoordinateSystem.RenumberAll(model, start)¶
Renumbers all of the coordinate systems in the model

Parameters:

model (Model) – Model that all coordinate systems will be renumbered in

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

To renumber all of the coordinate systems in model m, from 1000000:
Oasys.PRIMER.CoordinateSystem.RenumberAll(m, 1000000)
classmethod CoordinateSystem.RenumberFlagged(model, flag, start)¶
Renumbers all of the flagged coordinate systems in the model

Parameters:

model (Model) – Model that all the flagged coordinate systems will be renumbered in

flag (Flag) – Flag set on the coordinate systems that you want to renumber

start (integer) – Start point for renumbering

Returns:

No return value

Return type:

None

Example

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

Parameters:

flag (Flag) – Flag to use when selecting coordinate systems

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

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

Return type:

float

Example

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

Parameters:

model (Model) – Model that all the flagged coordinate systems will be sketched in

flag (Flag) – Flag set on the coordinate systems that you want to sketch

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

Parameters:

model (Model) – Model to get total for

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

Returns:

number of coordinate systems

Return type:

float

Example

To get the total number of coordinate systems in model m:
total = Oasys.PRIMER.CoordinateSystem.Total(m)
classmethod CoordinateSystem.UnblankAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unblanks all of the coordinate systems in the model

Parameters:

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

Parameters:

model (Model) – Model that the flagged coordinate systems will be unblanked in

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

Parameters:

model (Model) – Model that the defined flag for all coordinate systems will be unset in

flag (Flag) – Flag to unset on the coordinate systems

Returns:

No return value

Return type:

None

Example

To unset the flag f on all the coordinate systems in model m:
Oasys.PRIMER.CoordinateSystem.UnflagAll(m, f)
classmethod CoordinateSystem.UnsketchAll(model, redraw=Oasys.gRPC.defaultArg)¶
Unsketches all coordinate systems

Parameters:

model (Model) – Model that all coordinate systems will be unblanked in

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

Parameters:

model (Model) – Model that all coordinate systems will be unsketched in

flag (Flag) – Flag set on the coordinate systems that you want to unsketch

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

Instance methods¶

CoordinateSystem.AssociateComment(comment)¶
Associates a comment with a coordinate system

Parameters:

comment (Comment) – Comment that will be attached to the coordinate system

Returns:

No return value

Return type:

None

Example

To associate comment c to the coordinate system c:
c.AssociateComment(c)
CoordinateSystem.Blank()¶
Blanks the coordinate system

Returns:

No return value

Return type:

None

Example

To blank coordinate system c:
c.Blank()
CoordinateSystem.Blanked()¶
Checks if the coordinate system is blanked or not

Returns:

True if blanked, False if not

Return type:

bool

Example

To check if coordinate system c is blanked:
if c.Blanked():
    do_something..
CoordinateSystem.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 coordinate system c:
c.Browse()
CoordinateSystem.ClearFlag(flag)¶
Clears a flag on the coordinate system

Parameters:

flag (Flag) – Flag to clear on the coordinate system

Returns:

No return value

Return type:

None

Example

To clear flag f for coordinate system c:
c.ClearFlag(f)
CoordinateSystem.Copy(range=Oasys.gRPC.defaultArg)¶
Copies the coordinate system. The target include of the copied coordinate system 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:

CoordinateSystem object

Return type:

CoordinateSystem

Example

To copy coordinate system c into coordinate system z:
z = c.Copy()
CoordinateSystem.DetachComment(comment)¶
Detaches a comment from a coordinate system

Parameters:

comment (Comment) – Comment that will be detached from the coordinate system

Returns:

No return value

Return type:

None

Example

To detach comment c from the coordinate system c:
c.DetachComment(c)
CoordinateSystem.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 coordinate system c:
c.Edit()
CoordinateSystem.Flagged(flag)¶
Checks if the coordinate system is flagged or not

Parameters:

flag (Flag) – Flag to test on the coordinate system

Returns:

True if flagged, False if not

Return type:

bool

Example

To check if coordinate system c has flag f set on it:
if c.Flagged(f):
    do_something..
CoordinateSystem.GetComments()¶
Extracts the comments associated to a coordinate system

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

Parameters:

prop (string) – coordinate system property to get parameter for

Returns:

Parameter object if property is a parameter, None if not

Return type:

dict

Example

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

Returns:

string containing the keyword

Return type:

str

Example

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

Returns:

string containing the cards

Return type:

str

Example

To get the cards for csys c:
cards = v.KeywordCards()
CoordinateSystem.Next()¶
Returns the next coordinate system in the model

Returns:

CoordinateSystem object (or None if there are no more coordinate systems in the model)

Return type:

CoordinateSystem

Example

To get the coordinate system in model m after coordinate system c:
c = c.Next()
CoordinateSystem.Previous()¶
Returns the previous coordinate system in the model

Returns:

CoordinateSystem object (or None if there are no more coordinate systems in the model)

Return type:

CoordinateSystem

Example

To get the coordinate system in model m before coordinate system c:
c = c.Previous()
CoordinateSystem.SetFlag(flag)¶
Sets a flag on the coordinate system

Parameters:

flag (Flag) – Flag to set on the coordinate system

Returns:

No return value

Return type:

None

Example

To set flag f for coordinate system c:
c.SetFlag(f)
CoordinateSystem.Sketch(redraw=Oasys.gRPC.defaultArg)¶
Sketches the coordinate system. The coordinate system will be sketched until you either call CoordinateSystem.Unsketch(), CoordinateSystem.UnsketchAll(), Model.UnsketchAll(), or delete the model

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the coordinate system is sketched. If omitted redraw is true. If you want to sketch several coordinate systems 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 coordinate system c:
c.Sketch()
CoordinateSystem.Unblank()¶
Unblanks the coordinate system

Returns:

No return value

Return type:

None

Example

To unblank coordinate system c:
c.Unblank()
CoordinateSystem.Unsketch(redraw=Oasys.gRPC.defaultArg)¶
Unsketches the coordinate system

Parameters:

redraw (boolean) – Optional. If model should be redrawn or not after the coordinate system is unsketched. If omitted redraw is true. If you want to unsketch several coordinate systems 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 coordinate system c:
c.Unsketch()
CoordinateSystem.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:

CoordinateSystem object

Return type:

dict

Example

To check if CoordinateSystem property c.example is a parameter by using the CoordinateSystem.GetParameter() method:
if c.ViewParameters().GetParameter(c.example):
    do_something..
CoordinateSystem.Xrefs()¶
Returns the cross references for this coordinate system

Returns:

Xrefs object

Return type:

dict

Example

To get the cross references for coordinate system c:
xrefs = c.Xrefs()