current_frame

Context: frames

Synopsis

Set the specified frame as current.

Syntax

current_frame(id)

Description

The function arguments.

Argument	Description
id	A ChipsId structure identifying the item, or a string containing the name of the object.

The current_frame command sets the frame indicated by the argument as the current frame; see "ahelp currency" for general information on currency.

Use the info_current command to retrieve a list of all the current items in the ChIPS session, as shown below.

Examples

Example 1

chips> id = ChipsId()
chips> add_frame("id=data05")
chips> add_frame("id=data07")
chips> id.frame = "data05"
chips> current_frame(id)

Two frames are created; the second frame is current after it is created. The id.frame command sets the frame value of the ChipsId structure to the first frame, then the current_frame command makes that frame current.

The output of info_current for this session is:

chips> print(info_current())
Window [win1]
  Frame [data05]
    Coord Sys [Frame Normalized]

Example 2

chips> add_frame("id=data05")
chips> add_frame()
chips> current_frame("data05")

Two frames are created. After the second frame is created, it is current. The current_frame command then sets the first frame as the current frame.

Example 3

chips> add_frame("id=data05")
chips> add_frame()
chips> current_frame("all")

Two frames are created. After the second frame is created, it is current. The current_frame command then makes all frames current.

Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.