current_frame

Synopsis

Set the specified frame as current.

current_frame( ChipsId )
current_frame( "frame_id" )
current_frame( "all" )

Description

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

• ChipsId - an optional ChipsId structure containing values to modify the currency state for the command.
• frame_id - identification tag given to each object that is created; use this to select a specific frame.
• all - sets all frames to be current.

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

Example 1

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

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:

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.

See Also

concepts

chipsid, currency

frames

add_frame, arrange_frames, blink_frames, delete_frame, display_frame, get_frame, hide_frame, move_frame, next_frame, reposition_frame, set_frame, tile, view_placed_frame, view_single_frame

utilities

erase, get_object_count