Patran 2008 r1 PCL Reference Manual Volume 1: Function Descriptions
Main Index
Corporate
Europe
Asia Pacific
MSC.Software Corporation 2 MacArthur Place Santa Ana, CA 92707 USA Telephone: (800) 345-2078 Fax: (714) 784-4056
MSC.Software GmbH Am Moosfeld 13 81829 Munich, Germany Telephone: (49) (89) 43 19 87 0 Fax: (49) (89) 43 61 71 6
MSC.Software Japan Ltd. Shinjuku First West 8F 23-7 Nishi Shinjuku 1-Chome, Shinjuku-Ku Tokyo 160-0023, JAPAN Telephone: (81) (3)-6911-1200 Fax: (81) (3)-6911-1201
Worldwide Web www.mscsoftware.com
Disclaimer This documentation, as well as the software described in it, is furnished under license and may be used only in accordance with the terms of such license. MSC.Software Corporation reserves the right to make changes in specifications and other information contained in this document without prior notice. The concepts, methods, and examples presented in this text are for illustrative and educational purposes only, and are not intended to be exhaustive or to apply to any particular engineering problem or design. MSC.Software Corporation assumes no liability or responsibility to any person or company for direct or indirect damages resulting from the use of any information contained herein. User Documentation: Copyright ©2008 MSC.Software Corporation. Printed in U.S.A. All Rights Reserved. This notice shall be marked on any reproduction of this documentation, in whole or in part. Any reproduction or distribution of this document, in whole or in part, without the prior written consent of MSC.Software Corporation is prohibited. The software described herein may contain certain third-party software that is protected by copyright and licensed from MSC.Software suppliers. Contains IBM XL Fortran for AIX V8.1, Runtime Modules, (c) Copyright IBM Corporation 1990-2002, All Rights Reserved. MSC, MSC/, MSC Nastran, MD Nastran, MSC Fatigue, Marc, Patran, Dytran, and Laminate Modeler are trademarks or registered trademarks of MSC.Software Corporation in the United States and/or other countries. NASTRAN is a registered trademark of NASA. PAM-CRASH is a trademark or registered trademark of ESI Group. SAMCEF is a trademark or registered trademark of Samtech SA. LS-DYNA is a trademark or registered trademark of Livermore Software Technology Corporation. ANSYS is a registered trademark of SAS IP, Inc., a wholly owned subsidiary of ANSYS Inc. ACIS is a registered trademark of Spatial Technology, Inc. ABAQUS, and CATIA are registered trademark of Dassault Systemes, SA. EUCLID is a registered trademark of Matra Datavision Corporation. FLEXlm is a registered trademark of Macrovision Corporation. HPGL is a trademark of Hewlett Packard. PostScript is a registered trademark of Adobe Systems, Inc. PTC, CADDS and Pro/ENGINEER are trademarks or registered trademarks of Parametric Technology Corporation or its subsidiaries in the United States and/or other countries. Unigraphics, Parasolid and I-DEAS are registered trademarks of UGS Corp. a Siemens Group Company. All other brand names, product names or trademarks belong to their respective owners.
P3*2008R1*Z*PCL*Z*DC-USR
Main Index
Contents PCL Reference Manual
1
Introduction Introduction
10
Patran User Interface Description Session and Journal Files
12
Features of Session and Journal Files
13
Interpreting Session and Journal Files
15
Function Description Organization Error Handling
18
Solving Problems
2
19
Basic Functions Introduction File Menu
22 23
Group Menu Viewing Menu
124 178
Viewport Menu Display Menu Tools Menu
3
220 261 353
Geometry Functions Introduction
470
Construct Actions Disassemble Actions
Main Index
11
471 777
16
iv PCL Reference Manual ==
Associate Actions
780
Disassociate Actions
788
Renumber Actions Sweep Actions
791 794
Verify Actions
815
Transform Actions Edit Actions
894
Delete Actions Utlities
4
818
986
997
Finite Element Functions Introduction
1004
Create Action
1006
Transform Action Sweep Action
1055 1067
Renumber Action Disassociate Action
1100
Equivalence Action
1102
Optimize Action
1120
Show Action
1191
Modify Action
1194
Delete Action
1238
1244
Property Assignment Functions Introduction
Main Index
1116
Verify Action
Utilities
5
1097
1254
CONTENTS v
Loads and Boundary Conditions Element Properties
1276
Experimental Data Fitting Beam Library Materials
6
1286
1299
1319
Load Cases Fields
1256
1343
1347
Results Postprocessing Functions Introduction
1370
Results Database Functions Results Utility Functions
1371 1374
Results Data Registers
1451
Data Register Definition Functions Data Register Query Functions
1453 1473
Data Register Operator Functions Direct Results Access
1491
1494
Results Display Manager
1497
Plot Tool Creation and Modification Functions Plot Tool Manipulation Functions Animation Functions
1532
Quick Plot Functions
1548
Plot Tool Query Functions
1557
Results Template Functions 1569 Session file commands 1569 Results Plot Sets 1589 Iterator Descriptions 1593 Plot Set Definition 1594
Main Index
1523
1498
vi PCL Reference Manual ==
Sample Plot Set Example 1594 Simple Plot Set Containing a Deformed Fringe Plot
7
XY Plot Functions Introduction
1616
Create Action Post Action
1617 1634
Modify Action
1642
Rename Action
1745
Delete Action
8
1746
FlightLoads Functions Introduction
1750
General Utilities
1751
Modeling Utilities
1754
AeroDynamic Utilities AeroElastic Utilities Loadsbrowser Utilities
9
1784 1793 1805
Preference Functions Introduction
1808
Analysis Preferences Global Preferences Graphics Preferences Report Preferences Geometry Preferences
1809 1812 1825 1855 1858
Finite Element Preferences
Main Index
1861
1599
CONTENTS vii
10
Broken, Obsolete, Modified and New Functions Introduction
1864
Basic Functions (Chapter 2)
1865
Geometry Application Preference (Chapter 3) Group Menu (Chapter 2)
1866
1867
Finite Element Modeling Preference (Chapter 4)
1868
Function Assignments Application Preference (Chapter 5) Results Postprocessing Application Preference (Chapter 6) XY Plotting Application Preference (Chapter 7)
1872
Preference Application Preference (Chapter 8)
1873
FlightLoads Preference (Chapter 9)
11
1874
Status Messages Introduction
1876
Status Conditions 1877 I/O and Import Status Conditions 1878 Analytical Solids Modeling Status Conditions 1886 Finite Element Model Status Conditions 1898 Results Status Conditions 1927 Application Interface Status Conditions 1948 PCL Status Conditions 2003 Core Status Conditions 2008 XY Status Conditions 2010 Group Status Conditions 2013 Preference Status Conditions 2021 Database Status Conditions 2022 List Processor Status Conditions 2030 Graphics Manager Status Conditions 2045 Application Status Conditions 2050 List Manager Status Conditions 2051 ID Dispenser Status Conditions 2053 Mesher Status Conditions 2054 IGES Status Conditions 2057 Unigraphics Status Conditions 2057 Session File Status Conditions 2063
Main Index
1869 1871
viii PCL Reference Manual ==
Command Line Interface Status Conditions 2064 NOODL Status Conditions 2064 Neutral File Status Conditions 2065 Loads and Boundary Conditions Status Conditions Materials Status Conditions 2076 Element Property Status Conditions 2085 Fields Status Conditions 2089 Event ManagerStatus Conditions 2096 Security Status Conditions 2097 Meshing Finite Elements Status Conditions 2101 Range Tree Status Conditions 2127 File Status Conditions 2128 P/Thermal Status Conditions 2137 Journal File Status Conditions 2166 Vector Utility Status Conditions 2167 Matrix Utility Status Conditions 2167 Topology Engine Status Conditions 2168 Express File Status Conditions 2170 Neutral File Export Status Conditions 2171 Remote Procedure Calls 2174 List Status Conditions 2174 Fatigue Status Conditions 2175 Team Status Conditions 2183 Utility Status Conditions 2184 CADDS File Status Conditions 2185 Mass Properties Status Conditions 2187 Post Processor Interface Status Conditions 2191 Database Import Status Conditions 2193 FreeBody Results Status Conditions 2196 Parameterization Status Conditions 2197 Laminate Modeler Status Conditions 2198 Design Study Status Conditions 2202 SGM_RSM 2204
Main Index
2071
PCL Reference Manual
Main Index
2 SimXpert Release Guide
Main Index
Chapter 1: Introduction PCL Reference Manual
1
Main Index
Introduction
Introduction
Patran User Interface Description
Session and Journal Files
Features of Session and Journal Files
13
Interpreting Session and Journal Files
15
Function Description Organization
Error Handling
Solving Problems
10
18 19
11
12
16
10 PCL Reference Manual Introduction
Introduction This manual provides a detailed description of many of the PCL functions “built-in” to Patran that are available to the user. Many of these functions can be used by themselves, combined to build user functions, or be used to provide the functionality behind the forms and pull down menus that are part of a user interface. These functions can be used at the command line or in a file to extend and customize Patran. This manual provides a partial list of the functions that can be listed as entries in session and journal files, allowing it to be used as an aid to the interpretation of these files. This manual is broken up into ten chapters that describe: Introduction
This chapter introduces the purpose and contents of this manual and describes the user interface and some of the features of journal and session files.
Basic Functions
This chapter documents the functions that are used in the implementation of the File, Group, Viewport, Viewing, Display and Tools items on the menu bar.
Geometry Functions
This chapter documents functions that are used to implement the “Geometry” form accessed through the switch bar. The switch bar is located between the menu bar and the tool bar near the top of the user interface.
Finite Element Functions
This chapter documents functions that are used in the implementation of the “Finite Elements” switch bar form.
Property Assignment Functions
This chapter documents functions that are used in the implementation of the “Loads/BC”, “Material”, “Properties”, “Load Cases”, and “Fields” switch bar forms.
Results Postprocessing Functions
This chapter documents functions that are used by the “Results” switch bar form.
XY Plot Functions
This chapter documents the functions that are used in the implementation of the “XY Plot” switch bar form.
Preference Functions
This chapter documents functions that are used to control some of the settings or preferences used by many of the other forms used in Patran. Many of these functions are used in the implementation of the “Preferences” menu bar item.
Main Index
Broken, Obsolete, Modified and New Functions
This chapter documents the changes that take place as functions are found to be broken, become obsolete, are modified or are new to the manual.
Status Messages
This chapter documents the different status messages in the status message database that can be accessed using the values returned by PCL functions.
Chapter 1: Introduction 11 Patran User Interface Description
Patran User Interface Description The primary user interface to Patran is composed of a main form with six basic features. Across the top of the main form is a menu bar through which a pull down menu system can be accessed. To the extreme right of the menu bar are icons that can be used to run common operations such as refreshing graphics, establishing the default window layering, resetting graphics, interrupting an operation in progress, providing a heartbeat monitor, undoing the last operation, or providing information about Patran. Next, is the switch bar, which is used to access forms that control the operations used to set up geometry, to mesh a model, to assign loads and boundary conditions, analyze a model, display the results, and so on.The fourth item on the display is the tool bar, which provides a ‘short cut’ to many of the settings available through the pull down menus. After the tool bar is the history window. This is a text window that can be scrolled by placing the cursor in the window with the mouse and using the up and down arrow keys or the scroll bar to the right of the window. The line of text on which the cursor is placed will appear in the sixth item on the display, the command line. The command line is a data box that allows for the direct entry of PCL code and commands that can be used to direct almost any operation through a command line rather than a graphical interface. Any operations through the menu bar, the switch bar, the tool bar, or entered on the command line may cause an entry to appear in the history window and to be echoed to the session and journal files. The history window, the session file, and the journal file list information that are either comments or commands in the PCL programming language.
Main Index
12 PCL Reference Manual Session and Journal Files
Session and Journal Files Many of the functions documented in this manual are designed to place an entry in the journal and session file for a database when they are executed. Both journal and session files keep track of operations that would modify a database and some of the settings in Patran. Session files track the operations done over a single work period, journal files track the operations done over the life of a database. All entries made to both the journal and session file take the form of a PCL, or ‘Patran Command Language’ statement. PCL provides the glue that ties all of the inputs from a user to the underlying code that composes Patran and provides the tools needed to modify and customize Patran.
Main Index
Chapter 1: Introduction 13 Features of Session and Journal Files
Features of Session and Journal Files Both session and journal files contain comments and calls to PCL functions. Entries to these files are made in response to six types of user inputs: changes in settings made through the menu bar, inputs made through the icons to the far right on the menu bar, the switch bar, the tool bar, the command line, and directly through calls to PCL functions. These files can be played back through Patran, repeating the operations listed in the files. There are some limitations caused by what is recorded in these files and how they are played back. Some editing may be required to work around these limitations to get the desired results from a play back of these files. One of the limitations of the these files are in the area of file paths. When Patran opens a database, both the path to the file and the file name are recorded in journal and session files as literal strings (the listing has been reformatted to better fit the page): uil_file_rebuild.start @ (“/some_other_system/patran/patran3/template.db”, @ “/my_system/wriggler.db”)
The source file path for the template file (“/some_other_system/patran /patran3/template.db”) was applied either by the user when the template file for the database was specified or from the default path and file settings. The default path is “/patran/patran3” but can be modified with the environment variable P3_HOME. The default template file name is “template.db”. If this session or journal file is executed on a different machine these path settings will be different and this file will require editing to make this command work. When a command in a session or journal file spawns another process, the results of executing a journal or session file may create results that are different from the Patran session that created the original file. If a session file passes a model to the translator for MSC Nastran, it will set up the files that MSC Nastran needs and start MSC Nastran. MSC Nastran runs as a separate process and Patran may or may not wait until the MSC Nastran process is done. If the session file is set not to wait for the process to finish, it will immediately move on to the next operation. If the next operation is to read the results of the MSC Nastran process which do not yet exist, playback of the journal or session file will fail. This situation will again require some editing to fix. During a Patran session, all operations are recorded in the journal and the session files. When an operation requires user input through a popup form, the answer provided by the user is always recorded in the session file but is sometimes not recorded in the journal file. The instances where user input is required, but not recorded in journal files, can cause problems when a journal file is played back through Patran. When the journal file playback gets to the point where user input is required, playback will stop until the user input is provided. If the user input is different than that provided when the journal file was made, the results of the playback will be modified. Journal and session files not only record the operations executed by the user but also the exact order in which those operations where executed by Patran. The order in which these operations are recorded can
Main Index
14 PCL Reference Manual Features of Session and Journal Files
affect the behavior of the playback of the journal and session files in which these operations are recorded. For example: creating two surfaces in a model by using “Geometry”, “Create”, “Surface”, “XYZ” and using the same vector and origin coordinate lists for both surfaces will cause a popup form to appear warning the user of the duplicate surfaces created by the operation. If the user repositions or resizes the model viewport while the popup form is on the screen and then answers the popup form after modifying the viewport, the PCL commands to modify the viewport will be recorded in the journal and session file before the reply to the popup form. When the journal or session file is played back using Patran, the reply the user supplied will be lost because of the order in which the operation commands where recorded and the user will be prompted with a popup form to supply the missing information. These issues with journal and session files do not limit the usefulness of these files but they do point out areas where the playback of a journal or session file may yield results that are different from what was expected.
Main Index
Chapter 1: Introduction 15 Interpreting Session and Journal Files
Interpreting Session and Journal Files As can be seen above in the example above that discusses hard coded path and file names in journal and session files, many of the arguments passed to PCL functions are listed as literal values in the journal and session files. Literal strings are always set off with double quotes (“). Arguments that appear to be arrays of integers can be literal strings set off with double quotes. The strings in that case are usually a list of points or vectors: STRING asm_create_hpat_xyz_created_ids[VIRTUAL] asm_const_hpat_xyz(“1”, “<1 1 1>”, “[0 0 0]”,@ “Coord 0”, @ asm_create_hpat_xyz_created_ids)
In this example: “1”
is a string literal containing the character 1.
“<1 1 1>”
is a string literal containing the description of a vector.
“[0 0 0]”
is a string literal containing the description of a point.
“Coord 0”
is a string literal containing the description of a coordinate frame.
and: elementprops_create(“ps1”, 71, 25, 30, 1, 1, 20, @ [13, 21, 4124, 4126, 4125],
In this example fragment, the eighth argument, [13, 21, 4124, 4126, 4125], is an array of five integers. If you are in doubt about the interpretation of a literal argument in a journal or session file, the argument can be passed to the PCL command “dump”, which will list what kind of argument has been passed in the history window. For example: dump “[0 0 0]”
will report STRING[7] = “[0 0 0]”
dump [0 0 0]
will report INTEGER(3) = [0, 0, 0]
dump <0 0 0>
will report “Missing operand to expression” indicating that this is an invalid argument.
The “dump” command can be a powerful tool to help better understand the contents of a journal or session file.
Main Index
16 PCL Reference Manual Function Description Organization
Function Description Organization The function descriptions that follow this chapter all use a common organization scheme for the information that they contain. The information layout is designed to place the most useful information about the function towards the front of the description so that it is easy to find. The details are placed towards the end of the description so that they can be found quickly but are separated out so that they do not serve as a distraction to the user. Each description is composed of seven sections: the function name and argument list, the “Description”, the “Input” section, the “Output” section, the “Error Conditions” section, the “Remarks” section, and the “Example” section.
Main Index
The Function Name and Argument List:
This heading, which starts the description of the function, identifies the name of the function and provides a list of arguments passed to the function. The argument list identifies the order in which they are passed to the function and by the names used for the arguments provide some information about how the arguments are used.
The Description Section:
This section provides a short description of what the function does and is to be used for.
The Input Section:
This section lists the values from the argument list at the top of the function description that are used for passing input information to the function being called. Each entry in this section will list the data type for that argument, the name of the argument, a description of the use of each argument, and an enumeration of the values or the range of values that can be used with each argument. The data types allowed in this section are REAL, INTEGER, LOGICAL, STRING, and WIDGET. Each argument listing will make use of square brackets “[]”, parenthesis “()” and the VIRTUAL keyword to identify the lengths of strings and the sizes of arrays when it is appropriate to do so. If the enumerated list of values that can be used with an argument is longer than about five entries, the list of allowed argument values will be listed as part of the remarks for the section.
Chapter 1: Introduction 17 Function Description Organization
Main Index
The Output Section:
This section lists the values from the argument list at the top of the function description that are used for passing output information to the calling function. Each entry in this section will list the data type for that argument, the name of the argument, a description of the use of each argument, and an enumeration of the values or the range of values that can be used with each argument. The data types allowed in this section are REAL, INTEGER, LOGICAL, STRING, and WIDGET. Each argument listing will make use of square brackets “[]”, parenthesis “()” and the VIRTUAL keyword to identify the lengths of strings and the sizes of arrays when it is appropriate to do so. If the enumerated list of values that can be used with an argument is longer than about five entries, the list of allowed argument values will be listed as part of the remarks for the section. This section will also list the for the function, if the function has one.
Error Conditions:
This section is used to enumerate the list of numbers that can be returned to report the status of a function through the of a function and the messages from the status message database that can be associated with each number. Every attempt has been made to make these lists as complete as possible but it is often impractical or impossible to do so. This section will contain a statement marking an error condition list as being incomplete when possible.
The Remarks Section:
This section is used to do several things: provide enumerated lists of values that can be used with inputs or are expected to be returned by outputs if they are too long for the “Input” and “Output” sections, list the messages that can be displayed in a popup form, and list any other details or information about the function that may be useful to a user. Many times the information in the “Remarks” section of a function description will seem redundant as it will duplicate much of the information listed in the “Error Conditions” section. The information is listed twice because it is being used to do two separate jobs: present information through a popup form and it is being used as a return value for program execution flow control.
The Examples Section:
This section of the function description contain a reference to a .pcl source file listing that makes use of the function being described.
18 PCL Reference Manual Error Handling
Error Handling All code can generate errors. In recognition of this, the PCL functions listed in this manual make use of a straight forward mechanism that passes information about the status of a function back from the function that has been called to the calling function. This is done through the that most functions supply. The general convention followed is that if something happens that prevents a function from successfully completing the job that it was designed to do it will return a positive non-zero integer number. If it completes its job successfully, it will return a value of 0. This returned integer value can then be put to use. It can be used in an IF statement to control the flow of the path of execution for your code, it can be used to trigger the a return out of the calling function, or it can be used to break out of a FOR or WHILE loop. The returned value can be used in whatever manner is appropriate for the design of the code being written. A good practice to follow is to design your code so that it marks any problem that prevents your function from completing its job by returning an error code that is returned by that status condition only. For example: the same returned status value should not be used to indicate that a file was not found because of an invalid path and that a file was not found because of an invalid path name. Using a unique status code for the return status of a function provides information about what caused the error and where the error occurred in a manner that can greatly simplify debugging your code. A list of all of the messages in the status message database is provided at the end of this manual as an aid in selecting return codes that are appropriate for specific status conditions. Most of the that are returned by the functions in this manual have messages associated with them. Status messages are all kept in a status message database that can be accessed through the use of several functions: msg_get_string(), user_message(), msg_to_form(), and msg_to_text(). The msg_get_string() is used to return a message from the message database to a string. The user_message() function takes a message code and displays the corresponding message in the history window. The msg_to_form() function can be used to get a message from the message database and display it a popup form; this is the mechanism that is used to create the popup forms that are listed in the “Remarks” section of the function descriptions. The msg_to_text() function can be used to write messages from the message database to a file. All of these functions are provided to create a rich set of tools that can be used by the code designer to be flexible in presenting error and status information as needed.
Main Index
Chapter 1: Introduction 19 Solving Problems
Solving Problems Just as all code can generate errors, all errors have a specific cause. A common source of errors and mysterious core dumps with PCL code is the misuse of string lengths and the sizes of arrays. There are no guarantees that a function will check the length of a string or the size of an array that is passed into the function. This can lead to a memory overwrite that will cause a core dump. Often the memory overwrite will not cause the code to fail immediately, it just sets the stage for a crash in an unrelated piece of code later somewhere else in your program. If the cause of a crash or core dump cannot seem to be isolated or it seems to move around for no discernible reason, check the lengths of strings and the sizes of arrays being passed as arguments to functions. Verify that calls to functions that dynamically allocated or free memory being used correctly and appropriately.
Main Index
20 PCL Reference Manual Solving Problems
Main Index
Chapter 2: Basic Functions PCL Reference Manual
2
Main Index
Basic Functions
Introduction
File Menu
Group Menu
Viewport Menu
Viewing Menu
178
Display Menu
261
Tools Menu
22 23 124 220
353
22 PCL Reference Manual Introduction
Introduction This chapter documents the functions that are used in the implementation of the File, Group, Viewport, Viewing, Display and Tools items on the menu bar. This chapter presents function descriptions in six separate sections:
Main Index
File Menu
This section is used to describe some of the functions used to import and export model geometry files to and from files that can be used by various types of CAD systems.
Group Menu
This section is used to describe functions that are used to create, delete, modify and transform groups of geometric and finite element model entities.
Viewport Menu
This section is used to describe functions that are used to create, delete, modify and retrieve the settings of named viewports.
Viewing Menu
This section is used to describe functions that are used to create, delete, modify and retrieve the settings of named views.
Display Menu
This section is used to describe functions that are used to control what and how geometric and finite element model entities are displayed in a viewport.
Tools Menu
This section is used to describe functions that used to create and manipulate lists of geometric and finite element model entities using the list processor and the list processor format. It is also used to describe some of the functions that can be used to create and report the mass properties associated with a model.
Chapter 2: Basic Functions 23 File Menu
File Menu This section is used to describe some of the functions used to import and export model geometry files to and from files that can be used by various types of CAD systems
neutold_import_neutral
(file_name, group_name, entity_flags, minimum_id, maximum_id, offset)
Description: This function is used to import a neutral file. Input: STRING
file_name[]
This value specifies the name of the neutral file to be imported.
STRING
group_name[]
This value specifies the name of the group to which the imported geometry will be added.
LOGICAL
entity_flags(35)
This value specifies an array of flags identifying the types of entities to be imported from the neutral file. See the remarks below for more information.
INTEGER
minimum_id(35)
This value specifies an array of values used to set the minimum ID values for the entities in the current database.
INTEGER
maximum_id(35)
This value specifies an array of values used to set maximum ID value for the entities in the current database.
INTEGER
offset(35)
This value specifies user supplied entity label or id offsets.
This function always returns a value of 0.
Output: INTEGER
Error Conditions: None. Remarks: The input value entity_flags controls which entity types are to be exported to the neutral file. The offset into the array identifies the data type. Setting the value at that offset to TRUE will cause that entity type to be written to the neutral file. The following table identifies the offset into the array for each entity type
Main Index
24 PCL Reference Manual File Menu
Offset
Entity type
Offset
Entity type
1
Nodes
19
View Factor
2
Elements
20
Named Components
3
Materials
21
grid#
4
Element Properties
22
Line
5
Coordinate Frames
23
Patch
6
Distributed Loads
24
Hyperpatch
7
Forces
25
(not used)
8
Displacements
26
(not used)
9
(not used)
27
(not used)
10
Node Temperature
28
(not used)
11
Element Temperature
29
(not used)
12
(not used)
30
(not used)
13
(not used)
31
(not used)
14
MPC
32
GFEG
15
Nodal Heating
33
CFEG
16
Distributed Heating
34
(not used)
17
Convection
35
(not used)
18
(not used)
This function can display an information popup message form with the following messages: 25000070
Neutral file reading completed successfully.
25000080
Loading Neutral file data into Memory.
25000023
%I% Packet%I%%A% read.
This function can display a query yes or no popup message form with the following message: 25000020
Do you want the Neutral File printed to the terminal as it is being read?
This function can display a fatal error popup message if an error value is returned by the function:
Main Index
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000090
Analysis code input was not found
Chapter 2: Basic Functions 25 File Menu
See the listing for this function Broken, Obsolete, Modified and New Functions for further information. Example: Please see neutold_import_neutral.
neutral_export2
(file_name, title, entity_flags, all_groups, number_of_groups, group_entity_ids)
Description: This function will generate a Patran 2.5 format neutral file from a Patran database. Input: STRING
file_name[]
This value specifies the name of the neutral file to be written.
STRING
title[]
This value specifies the title to put in the packet 25 title field.
LOGICAL
entity_flags(35)
This value specifies an array of flags used to identify the specific entity types to be exported. See the remarks below for more information.
LOGICAL
all_groups
This value should be set TRUE if the entire model is to be exported, FALSE if only selected groups are to be exported.
INTEGER
number_of_groups
If exporting selected groups, this value is used to indicate the number of groups being written to the neutral file.
INTEGER
group_entity_ids(number_of _groups)
If exporting selected groups, this value is used to pass the list of group IDs for the entities being written to the neutral file.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This function may return a nonzero value if an error occurs.
Main Index
26 PCL Reference Manual File Menu
Remarks: The input value entity_flags controls which entity types are to be exported to the neutral file. The offset into the array identifies the data type. Setting the value at that offset to TRUE will cause that entity type to be written to the neutral file. The following table identifies the offset into the array for each entity type Offset
Entity type
Offset
Entity type
1
Nodes
19
View Factor
2
Elements
20
Named Components
3
Materials
21
Grid
4
Element Properties
22
Line
5
Coordinate Frames
23
Patch
6
Distributed Loads
24
Hyperpatch
7
Forces
25
(not used)
8
Displacements
26
(not used)
9
(not used)
27
(not used)
10
Node Temperature
28
(not used)
11
Element Temperature
29
(not used)
12
(not used)
30
(not used)
13
(not used)
31
(not used)
14
MPC
32
GFEG
15
Nodal Heating
33
CFEG
16
Distributed Heating
34
(not used)
17
Convection
35
(not used)
18
(not used)
If more than 1000 entities are being written to the file of any one type, a percent complete bar is displayed. Messages get printed to the command window indicating the number of successful packets read. This function will display an information popup message form if opening the neutral file and writing the packet 25 and title information fails: 45000001
Unable to open output file. Aborting Neutral File Export.
This function will display an information popup message form at the completion of the operation: 45000099
Main Index
Neutral File export completed successfully.
Chapter 2: Basic Functions 27 File Menu
This function will display a warning popup message form if reading the database for coordinate, nodes, elements, properties, materials, mpcs, loads and boundary conditions fails: 45000002
Error writing Finite Element Model. Will try to complete Neutral File.
This function will display a warning popup message form if reading the named components from the database and writing them to the neutral file fails: 45000003
Error writing Named Components. Aborting FEM portion of Neutral File. Will try to complete writing geometry, if any.
Example: Please see neutral_export2 (p. 10) in the PCL Reference Manual Examples.
Main Index
28 PCL Reference Manual File Menu
p3_cad_get_entity_name
(p3id, p3type, attribute)
Description: This function will retrieve a string of a CAD name attribute for a Patran entity. The Patran identifier and entity type are used to lookup the associated CAD name attribute. Input: INTEGER
p3id
INTEGER
p3type
The Patran id of the entity used to look up the associated CAD name attribute. The Patran entity type. Valid entity type values are: 1 for a point, 2 for a curve, 3 for a surface, and 4 for a solid.
Output: STRING
attribute
The CAD name attribute.
INTEGER
This function returns a value of 0 if successful.
Error Conditions: 1
Out of memory
10
A corrupt attribute was detected.
255
Invalid string length.
257
Can’t reallocate virtual string array.
259
Not a virtual string.
13000211
Virtual memory has been exhausted.
13000212
There is an error interacting with the PERSISTENT_MEMORY relation in the database.
13000213
A database lookup failed to locate the target index key.
<non-zero>
Attribute not found
p3_cad_get_entity_strings
Main Index
(p3id, p3type, attrib_count, attrib_titles, attrib_values)
Chapter 2: Basic Functions 29 File Menu
Description: This function will retrieve all CAD string attributes for a Patran entity. The Patran identifier and entity type are used to look up the associated CAD string attributes. Input: INTEGER
p3id
INTEGER
p3type
The Patran id of the entity used to look up the associated CAD name attributes. The Patran entity type. Valid entity type values are: 1 for a point, 2 for a curve, 3 for a surface, and 4 for a solid.
Output: INTEGER
attrib_count
The number of string attributes associated to the referenced Patran entity.
STRING[]
attrib_titles
An array of CAD name attribute titles.
STRING[]
attrib_values
An array of CAD name attribute values.
INTEGER
This function returns a value of 0 if successful.
Error Conditions:
Main Index
1
Out of memory
10
A corrupt attribute was detected.
255
Invalid string length.
257
Can’t reallocate virtual string array.
259
Not a virtual string.
13000211
Virtual memory has been exhausted.
13000212
There is an error interacting with the PERSISTENT_MEMORY relation in the database.
13000213
A database lookup failed to locate the target index key.
<non-zero>
Attribute not found
30 PCL Reference Manual File Menu
p3_express_import
(option_file, file_name, geometry_tracking, reset_tolerance, tolerance_prompt, return_entity_count, entities)
Description: This function imports geometry information from a file using the express neutral file format. Input: STRING
option_file[]
This value specifies the name of the express options file which determines entity and group filters, etc. It is optional and can be input as an empty string or ““.
STRING
file_name[]
This value specifies the name of the express file to import.
LOGICAL
geometry_tracking
This value should be set to TRUE if a log file of geometry tracking is to be created.
LOGICAL
reset_tolerance
This value should be set to TRUE if the user will allow Patran to reset the tolerances.
LOGICAL
tolerance_prompt
LOGICAL
return_entity_count
This value should be set to TRUE if the user would like to be prompted before tolerances are changed. This value should be set to TRUE if Patran is to return a count of entities created in the entities array.
Output: INTEGER
entities (64)(2)
This value is an array of entity types and the number of types in the express file.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
-9999
This is an internal status condition. There is no corresponding status message in the message database.
55001011
The file option is not valid or not supported.
Chapter 2: Basic Functions 31 File Menu
Remarks: This function will import model geometry and finite element information from a file using the express file format, place them in the Patran database, and display them in the current viewport. It will display a popup form that will list a summary of the number of entities accessed from the express file. The PCL function p3_express_import_exit() must be called to properly terminate this import operation. See the function listing for the p3_express_options_file for more information on the express options file entered as the input value option_file. See Importing Express Neutral Files (p. 96) in the Patran Reference Manual for further information. This function can produce fatal popup message forms. Example: Please see p3_express_import (p. 11) in the PCL Reference Manual Examples.
p3_express_import_preview
(option_file, file_name, tolerance_check, return_entity_count, entities, cad_attributes, cad_tolerance, shortest_curve_length)
Description: This function previews geometry information from a file using the express neutral file format. Input: STRING
option_file[]
This value specifies the name of the express options file which determines entity and group filters, etc. It is optional and can be input as an empty string or ““.
STRING
file_name[]
This value specifies the name of the express file to import.
LOGICAL
tolerance_check
This value should be set to TRUE if the tolerance needs to be checked.
LOGICAL
return_entity_count
This value should be set to TRUE if this function is to return a count of entities created in the entities array.
INTEGER
entities (64)(2)
This value returns an array of entity types and the number of types in the express file.
STRING
cad_attributes[2](256)
This value returns the CAD system and model name.
REAL
cad_tolerance
This value returns the calculated CAD tolerance.
Output:
Main Index
32 PCL Reference Manual File Menu
REAL
shortest_curve_length
This value returns the shortest curve length for non-degenerate curves in the model. This value is calculated only if the input value tolerance_check is set to TRUE.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -9999
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: This function will read information about the model geometry and finite element information in a file using the express file format. It will display a popup form that will list a summary of the number of entities accessed from the express file. The PCL function p3_express_import_exit() must be called to properly terminate this import operation. See the function listing for the p3_express_options_file for more information on the express options file entered as the input value option_file. See Importing Express Neutral Files (p. 96) in the Patran Reference Manual for further information. This function can produce fatal popup message forms. This function can produce a warning popup message form with the following message: 55001012
%I% Error(s) encountered during generation of the import file in the foreign sending system. These errors are detailed in the log file%A%.
Example: Please see p3_express_import_preview (p. 12) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 33 File Menu
p3_express_import_exit
(delete_option_file, delete_express_file)
Description: This function is called to terminate an express neutral file import operation. Input: LOGICAL
delete_option_file
This value, when set to TRUE, will cause the express options file to be deleted.
LOGICAL
delete_express_file
This value, when set to TRUE, will cause the express neutral import file to be deleted.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 55000011
The file option is not valid or not supported.
55000014
The file was not found.
55000016
Unable to close the file.
Remarks: Call this function after calling p3_express_import() or p3_express_import_preview() to properly terminate the operation. This function can produce fatal popup message forms. Example: Please see p3_express_import_exit (p. 13) in the PCL Reference Manual Examples.
Main Index
34 PCL Reference Manual File Menu
p3_express_options_file
(option_file, versioning, file_format, action, source, transform_exists, transformation, number_of_groups, group_names, group_entities, group_layers, group_colors, all_entities, entities, all_layers, layers, all_colors, colors, trimmed_curve_type, trimmed_surface_type, solid_representation)
Description: This function writes an optional file that is used as an input to the p3_express_import() and p3_express_import_preview() functions. Input:
Main Index
STRING
option_file[]
This value specifies the name of the express options file to be created.
LOGICAL
versioning
This value, when set to TRUE, specifies the use of a version number to be used with the express options file being created.
INTEGER
file_format
This value sets the file format to be used in writing the file and can have the following values: 1 for ascii files, 2 for compressed ascii with no white space characters, and 3 for binary files.
INTEGER
action
This value specifies the type of operation that this options file will be used with. Currently, only the input file operation is supported. This argument can have the following values: 1 import file, 2 export file, 3 import modifications, and 4 export modifications.
INTEGER
source
This value specifies the source of the geometry entities. This argument can have values that are defined in the header file geometry_coos.i as the following symbols: MCDONNEL_DOUGLAS or 101254, DASSAULT_SYSTEMS or 40686, PARAMETRIC_TECHNOLOGY or 22058, MATRA or 32465, COMPUTER_VISION or 22085, PDA_ENGINEERING or 52054.
LOGICAL
transform_exists
This value, when set to TRUE, indicates that a transformation matrix is available in the input value transformation and is to be written to the options file.
Chapter 2: Basic Functions 35 File Menu
REAL
transformation[12]
This value expresses the transformation matrix to be written to the file. This arguement creates the transformation matrix for translators that provide a model units/scale factor: The scale factor value is added in the 1, 5, 9 locations of the matrix. This is applied to the geometry on import. /* * Build the transformation matrix based on the scale * factor */ FOR ( i = 1 TO 12 ) tmat(i) = 0.0 END FOR IF( scale_factor > 0.0 ) THEN use_tmat tmat(1) = tmat(5) = tmat(9) = END IF
Main Index
= TRUE scale_factor scale_factor scale_factor
INTEGER
number_of_groups
This value specifies the number of groups to be created in the options file.
STRING
group_names[number_of_groups]()
This value specifies an array of group names that will whose entities will be read from the express neutral file.
INTEGER
group_entities(number_of_groups)(64)
This value specifies the entities to be read in for each group from the express neutral file. Initialize all unused entries to 0. If the first entry is 0, then it is assumed that all entities are desired.
INTEGER
group_layers(number_of_groups)(256)
This value specifies the layers to be read in for each group from the express neutral file. Initialize all unused entries to -1. If the first entry is -1, then it is assumed that all layers are desired. Each entry in this argument can have a value ranging from 0 to 255 or 1 to 256 depending on the CAD system. A value of 257 indicates that the working or active layer will be accessed.
36 PCL Reference Manual File Menu
Main Index
INTEGER
group_colors(number_of_groups)(10)
This value specifies the colors to be read in for each group from the express neutral file. Initialize all unused entries to 0. If the first entry is 0, then it is assumed that all colors are desired. See the remarks below for more information.
LOGICAL
all_entities
This value, when set to TRUE, will cause all entities to be imported.
INTEGER
entities(64)
This value specifies the ID values for the entities to import from the express neutral file. All unused entries must be initialized to 0. This array is not used if the input value all_entities is set to TRUE.
LOGICAL
all_layers
Set this value to TRUE to import all layers.
INTEGER
layers(256)
This value specifies the layers to import from the express neutral file. All unused entries must be initialized to -1. This array is not used if the input value all_layers is set to TRUE.
LOGICAL
all_colors
Set this value to TRUE to import all colors.
INTEGER
colors(10)
This value specifies the colors to import from the express neutral file. All unused entries must be initialized to 0. This array is not used if the input value all_colors is set to TRUE.
INTEGER
trimmed_curve_type
This value specifies the trimmed curves type to be used with curves from the express neutral file. This argument can have the following values: 1 for 2-d or parametric trimming curves, 2 for 3-d or real space trimming curves, or 3 for no preference.
INTEGER
trimmed_surface_type
This value specifies the trimmed surface type to be used with surfaces from the express neutral file. This argument can have the following values: 1 for both general and simply trimmed surfaces, 2 for only general trimmed surfaces, or 3 for no preference.
INTEGER
solid_representation
This value specifies the solid representation type to be used with surfaces from the express neutral file. This argument can have the following values: 1 for boundary representation solids, 2 for the constituent surfaces of the boundary representation solid, or 3 for no preference.
Chapter 2: Basic Functions 37 File Menu
Output: INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 55000001
Unable to allocate memory.
55000006
The handle accessed is not a file handle.
55000011
Error(s) occurred which may be resolved by using a more refined tolerance.
55000014
The file was not found.
55000016
Unable to close the file.
55000022
Not a valid entity. Either the name is not correct or it is not supported.
Remarks: Each entry in the input value group_colors array input can have the following values:
0 1 2 3 4 5
color not used. all colors black white red orange
6 7 8 9 10
blue green yellow magenta cyan
This function can produce fatal popup message forms. The values allowed for the input value source are defined in the geometry_coos.i include file. Use the symbols that define these values instead of the values themselves to allow for any changes that may take place with these values in future releases of Patran. Example: Please see p3_express_options_file (p. 14) in the PCL Reference Manual Examples.
Main Index
38 PCL Reference Manual File Menu
p3_ps_open_ug
(ug_file_name, save_switch, sew_switch, filter, number_of_components)
Description: This function passes information from a Unigraphics parts file to the Unigraphics server through the use of a transmit file. Input: STRING
ug_file_name[]
This value specifies the name of the Unigraphics part file.
LOGICAL
save_switch
This value, when set to TRUE, will cause a copy of the file used to transmit information to the Unigraphics server to be saved. When this value is set to FALSE, the transmit file will not be saved.
LOGICAL
sew_switch
This value, when set to TRUE, will allow sewing to take place. When this value is set to FALSE, sewing will not take place.
INTEGER
filter[]
This value is used to specify which information from each entity that will be passed to the Unigraphics server. Offset 0 of this array is used to specify the number of entities. The array should be declared to have the (number of entities + 1) number of offsets. When a value in an offset is set to 0 the wire, sheet, and solid bodies information will be used. Specific entity type information can be used by setting the array to the values listed below.
INTEGER
number_of_components
This value returns the number of components in the Unigraphics parts file.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: None. Remarks: The types of entities used from the parts file can be specified by setting offsets in the input value filter to the following values:
Main Index
Chapter 2: Basic Functions 39 File Menu
Description
Main Index
Value
sgmpoint
10
sgmplane
20
sgmvector
30
PieceWise_Cubic_Polynomial_Curve
101
IGES_Nurb_Curve
102
IGES_Cubic_Spline
103
IGES_Arc
104
IGES_Composite_Curve
105
IGES_Line
106
IGES_Conic
107
IGES_PieceWise_Linear
108
Rational_Bezier
109
Curve_On_Surface
110
PDA_line
111
MDC_Curve
112
IGES_Offset_Curve
113
CATIA_Curve
114
COMPUTER_VISION_Curve
115
PieceWise_Rational_Polynomial_Curve
116
N_Dimensional_Cubic_Spline
117
MDC_V9Curve
118
Curve_Id_Reference
119
Plane_Project_Curve
120
IGES_Nurb_Surface
1001
IGES_Trimmed_Surface
1002
IGES_BiCubic_Patch_Network
1003
IGES_Surface_Of_Revolution
1004
IGES_Ruled_Surface
1005
IGES_Tabulated_Cylinder
1006
Rational_Bezier_Network
1007
Ordinary_Trimmed_Surface
1008
PDA_patch
1009
MDC_Surface
1010
Comments
40 PCL Reference Manual File Menu
Main Index
Bilinear_Coons_Surface
1011
IGES_Offset_Surface
1012
PTC_plane
1013
PTC_cylinder
1014
PTC_cone
1015
PTC_torus
1016
PTC_fillet_surface
1017
PTC_generalized_Coons_surface
1018
PTC_cylindrical_spline_surface
1019
CATIA_Surface
1020
COMPUTER_VISION_Surface
1021
PieceWise_Rational_Polynomial_Surface
1022
Fence_Surface
1023
Surface_on_Solid
1024
Curve_Interpolating_Surface
1025
Extruded_Surface
1026
Glide_Surface
1027
Sweep_Normal_Surface
1028
MDC_V9Surface
1029
Composite_Trim_Surface
1030
Surface_Id_Reference
1031
PTC_sphere
1032
MDC_Sculptured_Surface
1033
Ordinary_Composite_Trim_Surface
1034
MDC_Parent_Surface
1035
TESSELLATED_SURFACE
1036
PDA_hpat
2001
Ordinary_Body
2002
Tri_Linear_Solid
2003
Surface_Interpolating_Solid
2004
Solid_Of_Revolution
2005
Solid_6face
2006
Extruded_Solid
2007
General Brep Body with no parameterization.
Chapter 2: Basic Functions 41 File Menu
Glide_Solid
2008
Sweep_Normal_Solid
2009
Extruded_Body
2010
2 1/2 D Brep Body with no parameterization.
Ordinary_Volume
2011
Pseudo-brep, has no parameterization and ambiguous topology.
Solid_Id_Reference
2012
TricubicNet
2013
SEW_SHEETS_BY_LAYER
52937
Example: None
Main Index
Hyperpatch network.
42 PCL Reference Manual File Menu
p3_ps_open_ug_v2
(ug_file_name, import_option_flags, entity_filter, preview_filter, number_of_components)
Description: This function passes information from a Unigraphics parts file to the Unigraphics server through the use of a transmit file. Input: STRING
ug_file_name[]
This value specifies the name of the Unigraphics part file.
LOGICAL
import_option_flags[]
This value is used to specify which import options are ON. Offset 0 of this array is used to specify the number of options that are on. If using the default values, the number will be 0. The array should be declared to have the (number of options + 1) number of offsets. The possible offset values are as follows: =1; Unigraphics Sew =2; Save Transmit File =3; Import Attributes =4; Preview Attributes =5; Preview Assembly
INTEGER
Main Index
entity_filter[]
This value is used to specify which information from each entity that will be passed to the Unigraphics server. Offset 0 of this array is used to specify the number of entities. The array should be declared to have the (number of entities + 1 + number of layers + 2) number of offsets. When a value in an offset is set to 0 the wire, sheet, and solid bodies information will be used. The possible offset values are described below in Remarks.
Chapter 2: Basic Functions 43 File Menu
STRING
preview_filter[]
This value is used to specify which preview filter options are used for Attributes and Assembly Components. The array should be declared to have the (6+number of attributes + 2 + number of components ) number of offsets. The possible offset values are as follows: =1; “Attributes” =2; “2” =3; Name Attribute filter string ( * is default) =4; Object Attribute filter string ( * is default) =5; “I” or “E” ( I = import; E = Exclude) =6; number of attributes ( 0 = all attributes ) =6n; the n attribute names =6n+1; “Components” =6n+2; number of components ( 0 = all components) =6n+3; the m components names
Output: INTEGER
number_of_components
This value returns the number of components in the Unigraphics parts file.
INTEGER
This function returns a value of 1 when a Unigraphics piece part has been successfully imported and a value of 2 for a Unigraphics assembly. Any other non zero value indicates an error.
Error Conditions:
Main Index
21010310
Cannot connect to P3-UG Server on UNIX.
21010311
Cannot connect to P3-UG Server on NT.
21010301
Cannot extract Parasolid Transmit file from the Unigraphics Part.
21010302
Import failed because can’t find part.
20045
No Unigraphics Geometry was imported.
20047
Unigraphics Sewing was unable to continue.
44 PCL Reference Manual File Menu
Remarks: The types of entities used from the parts file can be specified by setting offsets in the input value entity_filter to the following values: Description
Value
MDC_Curve
112
MDC_Surface
1010
Ordinary_Body
2002
UG_Feature
-123997
IMPORT_BY_LAYER
52937
layer numbers
0-256
Comments
Example: None.
p3_ps_preload_part
(ug_file_name)
Description: This function calls the P3-UG Server to load the Unigraphics Part into UG/OPEN. . Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
This function returns a value of 1 if the Unigraphics Part is a piece part and a value of 2 when the Unigraphics Part is an assembly model.
Output: INTEGER
Error Conditions:
Example: None
Main Index
21010310
Cannot connect to P3-UG Server on UNIX.
21010311
Cannot connect to P3-UG Server on NT.
21010301
Cannot extract Parasolid Transmit file from the Unigraphics Part.
21010302
Import failed because can’t find part.
20045
No Unigraphics Geometry was imported.
20047
Unigraphics Sewing was unable to continue.
Chapter 2: Basic Functions 45 File Menu
p3_ug_get_attr_list
(ug_file_name, name_filter, object_filter, attr_count, attributes)
Description: This function will list the name and object attributes in a Unigraphics part based on the name filter and object filter specified. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
STRING
name_filter[]
The string specifying the filter to use to list the Unigraphics name attributes in a part.
STRING
object_filter[]
The string specifying the filter to use to list the Unigraphics object attributes in a part.
INTEGER
attr_count
The number of name and object attributes in the specified Unigraphics part.
STRING
attributes[][]
The names of the name and object attributes in the specified Unigraphics part.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions:
Example: None
p3_ug_xmt_import
(xmt_file_name, part_file_name, express_file_name, import_switch, sew_edges, ug_count, patran_count, tolerance)
Description: This function imports parasolid transmit file models. Input:
Main Index
STRING
xmt_file_name[512]
This value specifies the name of the transmit file.
STRING
part_file_name[512]
his value specifies the Unigraphics part file name. This value must include the full path and may be set to nothing or ““.
46 PCL Reference Manual File Menu
STRING
express_file_name[]
This value specifies the express options file name. This value may be set to nothing or ““.
LOGICAL
import_switch
This value specifies, when set to TRUE, that the transmit file should be imported. When this value is set to FALSE the transmit file will be previewed.
INTEGER
sew_edges
This value specifies sewing, verification, and cleanup options. The option values can be anded together to specify more than one option. The following option values are allowed: 2 to sew Patran edges, 4 to verify edges, 8 to remove degenerate faces, 16 to comvert trimmed to untrimmed surfaces, 32 to equivelance edge vertices.
Output: INTEGER
ug_count[5]
This value returns counts for the following items: offset 0, minimal or vertex bodies; offset 1, wire bodies; offset 2, sheet bodies; offset 3, b-rep bodies; offset 4, general bodies.
INTEGER
patran_count[4]
This value returns the number of: offset 0, points; offset 1, curves; offset 2, surfaces; offset 3, solids; created by the import process.
REAL
tolerance[2]
This value returns the suggested model tolerance for modeling and meshing operations in offset 0 and the graphics tolerance in offset 1.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: 1
This is an internal status condition. There is no corresponding status message in the message database.
21010002
Unigraphics reports error opening file%A%. Check part file, Path name, Version number and check run-time environment variables and/or support files.
21010007
A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010009
An error occurred while closing the model. Filename =%A%.
21010035
Example: None
Main Index
Unigraphics database%A% already referenced. Open a new Patran database to access another part.
Chapter 2: Basic Functions 47 File Menu
p3_ug_xmt_import_v1
(xmt_file_name, part_file_name, express_file_name, import_switch, sew_edges, ug_count, patran_count, n_layers, layer_ids, tolerance)
Description: This function imports parasolid transmit file models. Input: STRING
xmt_file_name[512]
This value specifies the name of the transmit file.
STRING
part_file_name[512]
his value specifies the Unigraphics part file name. This value must include the full path and may be set to nothing or ““.
STRING
express_file_name[]
This value specifies the express options file name. This value may be set to nothing or ““.
LOGICAL
import_switch
This value specifies, when set to TRUE, that the transmit file should be imported. When this value is set to FALSE the transmit file will be previewed.
INTEGER
sew_edges
This value specifies sewing, verification, and cleanup options. The option values can be anded together to specify more than one option. The following option values are allowed: 2 to sew Patran edges, 4 to verify edges, 8 to remove degenerate faces, 16 to comvert trimmed to untrimmed surfaces, 32 to equivelance edge vertices.
Output:
Main Index
INTEGER
ug_count[5]
This value returns counts for the following items: offset 0, minimal or vertex bodies; offset 1, wire bodies; offset 2, sheet bodies; offset 3, b-rep bodies; offset 4, general bodies.
INTEGER
patran_count[4]
This value returns the number of: offset 0, points; offset 1, curves; offset 2, surfaces; offset 3, solids; created by the import process.
INTEGER
n_layers
This value returns the number of layers used in system that generated the parasolid transmit file.
INTEGER
layer_ids[5][256]
This value returns the layer ids used in the system that generated the parasolid transmit file.
REAL
tolerance[2]
This value returns the suggested model tolerance for modeling and meshing operations in offset 0 and the graphics tolerance in offset 1.
48 PCL Reference Manual File Menu
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: 1
This is an internal status condition. There is no corresponding status message in the message database.
21010002
Unigraphics reports error opening file%A%. Check part file, Path name, Version number and check run-time environment variables and/or support files.
21010007
A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010009
An error occurred while closing the model. Filename =%A%.
21010035
Unigraphics database%A% already referenced. Open a new Patran database to access another part.
Example: None.
p3_ug_xmt_preview
(xmt_file_name, ug_count, n_layers, layer_ids)
Description: This function previews the contents of parasolid transmit file models. Input: STRING
xmt_file_name[512]
This value specifies the name of the transmit file.
INTEGER
ug_count[5]
This value returns counts for the following items: offset 0, minimal or vertex bodies; offset 1, wire bodies; offset 2, sheet bodies; offset 3, b-rep bodies; offset 4, general bodies.
INTEGER
n_layers
This value returns the number of layers used in system that generated the parasolid transmit file.
INTEGER
layer_ids
This value returns the layer idsused in system that generated the parasolid transmit file
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions: Example: None.
Main Index
Chapter 2: Basic Functions 49 File Menu
p3_ug_get_part_occ_list
(ug_file_name, occ_count, occurrences)
Description: This function will list the names of the Assembly occurrences in a Unigraphics part. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
INTEGER
occ_count
The number of Assembly occurrences in the specified Unigraphics part.
STRING
occurrences[][]
The names of the Assembly occurrences in the specified Unigraphics part.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions:
Example: None
pfk_get_features
(ug_file_name, feature_names, suppress_flag)
Description: This function calls the P3-UG Server to get the Unigraphics features. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
STRING
feature_names[256] (VIRTUAL)
The names of features
INTEGER
suppress_flag (VIRTUAL)
The state of the features, whether they are suppressed or unsuppressed.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions:
Main Index
50 PCL Reference Manual File Menu
Example: None
pfk_get_feat_with_params
(ug_file_name, feature_names, suppress_flag)
Description: This function calls the P3-UG Server to get the Unigraphics features that have parameters. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
STRING
feature_names[256] (VIRTUAL)
The names of features that have parameters
INTEGER
suppress_flag (VIRTUAL)
The state of the features, whether they are suppressed or unsuppressed.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions:
Example: None.
pfk_get_num_feat
(ug_file_name, num_features)
Description: This function calls the P3-UG Server to get the number of Unigraphics features in a part. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
INTEGER
num_features
The number of features in a part.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions:
Main Index
Chapter 2: Basic Functions 51 File Menu
Example: None.
pfk_get_num_feat_with_params
(ug_file_name, num_features)
Description: This function calls the P3-UG Server to get the number of Unigraphics features that have parameters. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
INTEGER
num_features
The number of features that have parameters
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions:
Example: None
pfk_get_versioned_file_name
(ug_file_name)
Description: This function calls the P3-UG Server to get the name of the Unigraphics Part that is a copy of the original part imported into Patran. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
This function returns a value of 0 if successful.
Output: INTEGER
Error Conditions:
Example: None.
Main Index
52 PCL Reference Manual File Menu
pfk_highlight_feat_name
(num_features, feature_names)
Description: This function highlights the features in the Patran viewport. Input: INTEGER
num_features
The number of features to highlight.
STRING
feature_names[]
The names of the features to highlight.
This function returns a value of 0 if successful.
Output: INTEGER
Error Conditions:
Example: None
pfk_create_ug_import
(ug_file_name, import_options_flags, entity_filter, preview_filter, sew_option, option_file, versioning, file_format, action, source, transform_exists, transformation, number_of_groups, group_names, group_entities, group_layers, group_colors, all_entities, entities, all_layers, layers, all_colors, colors, trimmed_curve_type, trimmed_surface_type, solid_representation)
Description: This function creates a Unigraphics Import Object. It is called in conjunction with p3_ps_open_ug_v2 and p3_ug_xmt_import_v1. Input: STRING
Main Index
ug_file_name[]
This value specifies the name of the Unigraphics part file.
Chapter 2: Basic Functions 53 File Menu
LOGICAL
import_option_flags[]
This value is used to specify which import options are ON. Offset 0 of this array is used to specify the number of options that are on. If using the default values, the number will be 0. The array should be declared to have the (number of options + 1) number of offsets. The possible offset values are as follows: =1; Unigraphics Sew =2; Save Transmit File =3; Import Attributes =4; Preview Attributes =5; Preview Assembly
INTEGER
Main Index
entity_filter[]
This value is used to specify which information from each entity that will be passed to the Unigraphics server. Offset 0 of this array is used to specify the number of entities. The array should be declared to have the (number of entities + 1 + number of layers + 2) number of offsets. When a value in an offset is set to 0 the wire, sheet, and solid bodies information will be used. The possible offset values are described below in Remarks.
54 PCL Reference Manual File Menu
STRING
preview_filter[]
This value is used to specify which preview filter options are used for Attributes and Assembly Components. The array should be declared to have the (6+number of attributes + 2 + number of components ) number of offsets. The possible offset values are as follows: =1; “Attributes” =2; “2” =3; Name Attribute filter string ( * is default) =4; Object Attribute filter string ( * is default) =5; “I” or “E” ( I = import; E = Exclude) =6; number of attributes ( 0 = all attributes ) =6n; the n attribute names =6n+1; “Components” =6n+2; number of components ( 0 = all components) =6n+3; the m component names
INTEGER
sew_option
This value specifies sewing, verification, and cleanup options. The option values can be anded together to specify more than one option. The following option values are allowed: 2 to sew Patran edges, 4 to verify edges, 8 to remove degenerate faces, 16 to comvert trimmed to untrimmed surfaces, 32 to equivelance edge vertices.
Main Index
STRING
option_file[]
This value specifies the name of the express options file to be created.
LOGICAL
versioning
This value, when set to TRUE, specifies the use of a version number to be used with the express options file being created.
INTEGER
file_format
This value sets the file format to be used in writing the file and can have the following values: 1 for ascii files, 2 for compressed ascii with no white space characters, and 3 for binary files.
Chapter 2: Basic Functions 55 File Menu
INTEGER
action
This value specifies the type of operation that this options file will be used with. Currently, only the input file operation is supported. This argument can have the following values: 1 import file, 2 export file, 3 import modifications, and 4 export modifications.
INTEGER
source
This value specifies the source of the geometry entities. This argument can have values that are defined in the header file geometry_coos.i as the following symbols: MCDONNEL_DOUGLAS or 101254, DASSAULT_SYSTEMS or 40686, PARAMETRIC_TECHNOLOGY or 22058, MATRA or 32465, COMPUTER_VISION or 22085, PDA_ENGINEERING or 52054.
LOGICAL
transform_exists
This value, when set to TRUE, indicates that a transformation matrix is available in the input value transformation and is to be written to the options file.
REAL
transformation[12]
This value expresses the transformation matrix to be written to the file. This arguement creates the transformation matrix for translators that provide a model units/scale factor: The scale factor value is added in the 1, 5, 9 locations of the matrix. This is applied to the geometry on import. /* * Build the transformation matrix based on the scale * factor */ FOR ( i = 1 TO 12 ) tmat(i) = 0.0 END FOR IF( scale_factor > 0.0 ) THEN use_tmat = TRUE tmat(1) = scale_factor tmat(5) = scale_factor tmat(9) = scale_factor END IF
Main Index
INTEGER
number_of_groups
This value specifies the number of groups to be created in the options file.
STRING
group_names[number_of_grou ps]()
This value specifies an array of group names that will whose entities will be read from the express neutral file.
56 PCL Reference Manual File Menu
Main Index
INTEGER
group_entities(number_of_groups)(64)
This value specifies the entities to be read in for each group from the express neutral file. Initialize all unused entries to 0. If the first entry is 0, then it is assumed that all entities are desired.
INTEGER
group_layers(number_of_groups)(256)
This value specifies the layers to be read in for each group from the express neutral file. Initialize all unused entries to -1. If the first entry is -1, then it is assumed that all layers are desired. Each entry in this argument can have a value ranging from 0 to 255 or 1 to 256 depending on the CAD system. A value of 257 indicates that the working or active layer will be accessed.
INTEGER
group_colors(number_of_groups)(10)
This value specifies the colors to be read in for each group from the express neutral file. Initialize all unused entries to 0. If the first entry is 0, then it is assumed that all colors are desired. See the remarks below for more information.
LOGICAL
all_entities
This value, when set to TRUE, will cause all entities to be imported.
INTEGER
entities(64)
This value specifies the ID values for the entities to import from the express neutral file. All unused entries must be initialized to 0. This array is not used if the input value all_entities is set to TRUE.
LOGICAL
all_layers
Set this value to TRUE to import all layers.
INTEGER
layers(256)
This value specifies the layers to import from the express neutral file. All unused entries must be initialized to -1. This array is not used if the input value all_layers is set to TRUE.
LOGICAL
all_colors
Set this value to TRUE to import all colors.
INTEGER
colors(10)
This value specifies the colors to import from the express neutral file. All unused entries must be initialized to 0. This array is not used if the input value all_colors is set to TRUE.
INTEGER
trimmed_curve_type
This value specifies the trimmed curves type to be used with curves from the express neutral file. This argument can have the following values: 1 for 2-d or parametric trimming curves, 2 for 3-d or real space trimming curves, or 3 for no preference.
Chapter 2: Basic Functions 57 File Menu
INTEGER
trimmed_surface_type
This value specifies the trimmed surface type to be used with surfaces from the express neutral file. This argument can have the following values: 1 for both general and simply trimmed surfaces, 2 for only general trimmed surfaces, or 3 for no preference.
INTEGER
solid_representation
This value specifies the solid representation type to be used with solids from the express neutral file. This argument can have the following values: 1 for boundary representation solids, 2 for the constituent surfaces of the boundary representation solid, or 3 for parameterized solids.
INTEGER
number_of_ components
This value returns the number of components in the Unigraphics parts file.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions: 21001326
The named part may not be imported at this time. A Cad Model entity was not able to be created for the part. This probably means that either a parasolid transmit file or another Unigraphics part of the same name has been imported into the model.
Example: None.
pfk_is_part_imported
(ug_file_name, is_imported)
Description: This function calls the P3-UG Server to check if the Unigraphics Part if it is already imported into the Patran database. Input: STRING
ug_file_name[512]
LOGICAL
is_imported
This value specifies the Unigraphics part file name. This value must include the full path. =TRUE if part is already imported into Patran. =FALSE if part is not already imported into Patran.
Output: INTEGER
Main Index
This function returns a value of 0 if successful.
58 PCL Reference Manual File Menu
Error Conditions: 21010035
Unigraphics database%A% already referenced. Open a new Patran database to access another part.
Example: None.
pfk_modify_feature_part_name
(ug_file_name)
Description: This function stores the name of the Unigraphics Part that is a copy of the original part imported into Patran to the Patran database. This is used when the location of the copied part has been changed. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
This function returns a value of 0 if successful.
Output: INTEGER
Error Conditions: None Example: None
pfk_reimport
(ug_file_name)
Description: This function calls the P3-UG Server to re-import the Unigraphics Part if it is already imported into the Patran database. Input: STRING
ug_file_name[512]
This value specifies the Unigraphics part file name. This value must include the full path.
This function returns a value of 0 if the Unigraphics Part successfully re-imports.
Output: INTEGER
Main Index
Chapter 2: Basic Functions 59 File Menu
Error Conditions: 21010035
Unigraphics database%A% already referenced. Open a new Patran database to access another part.
Example: None
pfk_suppress_feat
(num_features, feature_names)
Description: This function calls the P3-UG Server to suppress the Unigraphics features. Input: INTEGER
num_features
The number of features to suppress.
STRING
feature_names[]
The names of the features to suppress.
This function returns a value of 0 if successful.
Output: INTEGER
Error Conditions:
Example: None.
pfk_unsuppress_feat
(num_features, feature_names)
Description: This function calls the P3-UG Server to unsuppress the Unigraphics features. Input: INTEGER
num_features
The number of features to unsuppress.
STRING
feature_names[]
The names of the features to unsuppress.
This function returns a value of 0 if successful.
Output: INTEGER
Error Conditions:
Main Index
60 PCL Reference Manual File Menu
Example: None
pfk_update
()
Description: This function calls the P3-UG Server to regenerate the Unigraphics model with the latest feature editing changes and updates the Patran model accordingly. Input:
Output: INTEGER
This function returns a value of 0 if successful.
Error Conditions: 21010303
Regeneration failed because cannot re-open the part.
Example: None
ps_get_body_integer_attribute
(p3id, p3type, identifier, field_no, n_values, attribute_values)
Description: This function will retrieve integer values of a Parasolid integer attribute that is attached to a Patran entity. The attribute definition must be identified by the input “identifier”. The Patran id and entity type are used to lookup the associated Parasolid attribute definition. Input: INTEGER
p3id
INTEGER
p3type
The Patran id of the entity used to look up the associated Parasolid attribute definition. The Patran entity type. Valid entity type values are: 1 for a point, 2 for a curve, 3 for a surface, and 4 for a solid
STRING
Main Index
identifier
The string by which the attribute definition is identified.
Chapter 2: Basic Functions 61 File Menu
INTEGER
field_no
The index to the location of the string field of the attribute definition.
INTEGER
n_values
The number of integer attribute values.
REAL
attribute_values[]
The Parasolid integer attribute values.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions: 1
Out of memory.
4
Parasolid tag not found
7
The specified attribute does not exist.
8
The Parasolid attribute class does not exist.
9
The Parasolid attribute definition was not found.
11
Non-printing characters in name.
255
Invalid string length.
257
Can’t reallocate virtual string array
259
Not a virtual string.
5013
The attribute does not have a field with this number.
5014
The field is not a string field.
13000211
Virtual memory has been exhausted.
13000212
There is an error interacting with the PERSISTENT_MEMORY relation in the database.
13000213
A database lookup failed to locate the target index key.
<non-zero>
Attribute not found.
Note:
Main Index
The value for “field_no” will be “0” for most if not all attributes.
62 PCL Reference Manual File Menu
ps_get_body_real_attribute
(p3id, p3type, identifier, field_no, n_values, attribute_values)
Description: This function will retrieve real values of a Parasolid real attribute that is attached to a Patran entity. The attribute definition must be identified by the input “identifier”. The Patran id and entity type are used to lookup the associated Parasolid attribute definition. Input: INTEGER
p3id
INTEGER
p3type
The Patran id of the entity used to look up the associated Parasolid attribute definition. The Patran entity type. Valid entity type values are: 1 for a point, 2 for a curve, 3 for a surface, and 4 for a solid
STRING
identifier
The string by which the attribute definition is identified.
INTEGER
field_no
The index to the location of the string field of the attribute definition.
INTEGER
n_values
The number of real attribute values.
REAL
attribute_values[]
The Parasolid real attribute values.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions:
Main Index
1
Out of memory.
4
Parasolid tag not found
7
The specified attribute does not exist.
8
The Parasolid attribute class does not exist.
9
The Parasolid attribute definition was not found.
11
Non-printing characters in name.
255
Invalid string length.
257
Can’t reallocate virtual string array
Chapter 2: Basic Functions 63 File Menu
259
Not a virtual string.
5013
The attribute does not have a field with this number.
5014
The field is not a string field.
13000211
Virtual memory has been exhausted.
13000212
There is an error interacting with the PERSISTENT_MEMORY relation in the database.
13000213
A database lookup failed to locate the target index key.
<non-zero>
Attribute not found.
Note:
The value for “field_no” will be “0” for most if not all attributes.
ps_get_body_string_attribute
(p3id, p3type, identifier, field_no, attribute)
Description: This function will retrieve a Parasolid string attribute that is attached to a Patran entity. The attribute definition must be identified by the input “identifier” and attached to a Parasolid entity at the body layer. The Patran ID and entity type are used to lookup the associated Parasolid attribute definition. Note:
For identifier “SDL/TYSA_NAME”, the field_no = 0
Input: INTEGER
p3id
INTEGER
p3type
The Patran id of the entity used to look up the associated Parasolid string attribute. The Patran entity type. Valid entity type values are: 1 for a point, 2 for a curve, 3 for a surface, and 4 for a solid.
STRING
identifier
The string by which the attribute definition is identified.
INTEGER
field_no
The index to the location of the string field of the attribute definition.
Output:
Main Index
64 PCL Reference Manual File Menu
STRING
attribute
The Parasolid string attribute.
INTEGER
This function returns a value of 0 if successful.
Error Conditions: 1
Out of memory
4
Parasolid tag not found.
7
The specified attribute does not exist.
9
The Parasolid attribute definition was not found.
11
Non-printing characters in name.
255
Invalid string length.
257
Can’t reallocate virtual string array.
259
Not a virtual string.
13000211
Virtual memory has been exhausted.
13000212
There is an error interacting with the PERSISTENT_MEMORY relation in the database.
13000213
A database lookup failed to locate the target index key.
<non-zero>
Attribute not found
Example: ps_get_body_string_attribute (p. 17) in the PCL Reference Manual Examples.
ps_get_string_attribute
(p3id, p3type, classname, field, attribute)
Description: This function will retrieve a Parasolid string attribute that is attached to a Patran entity. The attribute definition must be identified by the input “identifier” and attached to a Parasolid Entity at the topology layer. The Patran id and entity type are used to lookup the associated Parasolid attribute definition. Input: INTEGER
Main Index
p3id
The Patran id of the entity used to look up the associated Parasolid id.
Chapter 2: Basic Functions 65 File Menu
INTEGER
p3type
The Patran entity type. Valid entity type values are: 1 for a point, 2 for a curve, 3 for a surface, and 4 for a solid.
STRING
classname
The Parasolid attribute class. ( See Parasolid Reference Manual for more information. )
INTEGER
field
The Parasolid attribute field. ( See Parasolid Reference Manual for more information. )
STRING
attribute
The Parasolid string attribute.
INTEGER
This function returns a value of 0 if successful.
Output:
Error Conditions: 1
Out of memory
4
Parasolid tag not found
7
The specified attribute does not exist
8
The Parasolid attribute class does not exist. (See Parasolid reference for more information.
9
The Parasolid attribute definition was not found. (See Parasolid reference for more information.
11
Non-printing characters in name - (see parasolid_kernel.h)
255
Invalid string length.
257
Can’t reallocate virtual string array.
259
Not a virtual string.
5013
The attribute does not have a field with this number (see parasolid_kernel.h.)
Main Index
5014
The field is not a string field - (see parasolid_kernel.h.)
13000211
Virtual memory has been exhausted.
13000212
There is an error interacting with the PERSISTENT_MEMORY relation in the database.
66 PCL Reference Manual File Menu
13000213
A database lookup failed to locate the target index key.
13000215
A database lookup failed to locate the target index key
Example: ps_get_body_string_attribute (p. 17) in the PCL Reference Manual Examples.
select_focus.exit
()
Description: This function will hide the currently displayed select menu, clear the current filter, and reset the currently selected data box. Input: None. Output: None. Error Conditions: None. Remarks: None Example: Please see select_focus.exit (p. 23) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 67 File Menu
sgm_cad_access_v1
(file_name, file_name_length, group_name, group_name_length, entity_toggle_values, simply_trimmed, access_as_solids, enable_tol_prompt, color_toggle_values, all_layers, active_layer, layer_numbers, model_type, number_of_groups, group_entity_ids, group_entity_values, group_color_values,active_layer_values, layer_pointers, group_layers, n_ug_layers, ug_count, patran_count)
Description: This function is used to import a Unigraphics part file defining the geometry of a model. Input:
Main Index
STRING
file_name[]
This value specifies the name of the path and the file to be imported.
INTEGER
file_name_length
This value specifies the number of characters in the file_name input value.
STRING
group_name[80]
This value specifies the name of the group to which the imported geometry will be added.
INTEGER
group_name_length
This value specifies the number of characters in the group_name input value.
LOGICAL
entity_toggle_values(18)
This value specifies an array used to select the geometry entity types to be imported where the offset into the array defines the entity type. The value at that offset will be set TRUE if that entity type is to be imported. See the remarks below for more information.
LOGICAL
simply_trimmed
This value, when set TRUE, causes all surfaces to be imported as simple trimmed surfaces and when set FALSE all surfaces are imported as general trimmed surfaces.
LOGICAL
access_as_solids
This value, when set to TRUE, allows all imported geometric entities are to be accessed as solids. Set this value to FALSE if the imported geometric entities define constituent surfaces.
LOGICAL
enable_tol_prompt
This value, when set to TRUE, enables the user to be prompted for the global model tolerance. When this value is set to FALSE, the currently defined global model tolerance is used.
68 PCL Reference Manual File Menu
Main Index
LOGICAL
color_toggle_values(14)
This value specifies the overall color filter values. Currently, these values are ignored.
LOGICAL
all_layers
Set this value to TRUE if all entities identified by the input value entity_toggle_values from all layers should be imported.
LOGICAL
active_layer
This value should be set to TRUE if only the active or work layer entities will be imported.
INTEGER
layer_numbers(256)
This value specifies an input value that contains the layer values entered by the user from which entities will be imported.
STRING
model_type[6]
This value specifies the CAD model type and should always be set to “ug”.
INTEGER
number_of_groups
This value specifies the number of groups defined. This input has a maximum value of 256.
INTEGER
group_entity_ids(number_of _groups)
This value specifies an array that specifies the ID values used for each entity group.
LOGICAL
group_entity_values(number _of_groups, 20)
This value specifies a two dimensional array that contains values set to TRUE if an entity is to be included and FALSE if an entity is not to be included in the group being imported. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the entity type. See the remarks below for more information.
LOGICAL
group_color_values(number _of_groups, 14)
This value specifies a two dimensional array that contains values set to TRUE if a color value is to be used. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the color type. Currently this input value is ignored.
LOGICAL
active_layer_values(number _of_groups)
This value specifies an array where the value at an offset corresponding to the offset for the group id in the group_entity_values input value to is set to TRUE if an entity in the active layer is included in the group identified by the offset into this array.
Chapter 2: Basic Functions 69 File Menu
INTEGER
layer_pointers(number_of_gr This value specifies an array where the offset into oups) the array corresponds with the offset into the group_entity_ids array that lists the group ids. The value at that offset in this array identifies the offset into the group_layers array where the number of layer values for each group is stored. This array can store values that range from 1 to (512 number_of_groups).
INTEGER
group_layers(512)
This value specifies an array that contains values used to identify the number of layers imported for each group.
INTEGER
ug_count(256, 37)
This value specifies a two dimensional array that uses the first dimension to identify a layer. The second dimension is used to identify a particular entity type. The cell value indicates the number of entities of a particular entity type present on a particular layer.
INTEGER
patran_count(4)
This value indicates the number of entities that were successfully imported. See the remarks below for more information.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: 1
This is an internal status condition. There is no corresponding status message in the message database.
21010002
Unigraphics reports error opening file%A%. Check part file, Path name, Version number and check run-time environment variables and/or support files.
21010007
A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010009
An error occurred while closing the model. Filename =%A%.
21010035
Unigraphics database%A% already referenced. Open a new Patran database to access another part.
Remarks: The input value entity_toggle_values and the second dimension of the two dimensional input value group_entity_values are used to select the geometry entities to be imported where the offset into the array indicates the geometry type to be imported when set TRUE as follows:
Main Index
70 PCL Reference Manual File Menu
Offset
Geometry type
Offset
Geometry type
1
LINE
10
TAB_CYL
2
ARC
11
RUL_SURF
3
CONIC
12
BOUND_PLANE
4
CUBIC_SPLINE
13
SCULP_SURF
5
B_SPLINE
14
FILLET_SURF
6
CYLINDER
15
B_SURF
7
CONE
16
OFFSET_SURF
8
SPHERE
17
FRGN_SURF
9
SURF_REV
19
UG_SOLID
The output value patran_count is used to count several different types of operations: Offset Count Type 1
Not used. Should always be set to the initial value assigned to that offset.
2
Counts the number of ordinary trimmed surfaces.
3
Counts the number of: MDC Surfaces, IGES trimmed surfaces, Composite trimmed surfaces.
4
Number of entities written to the database.
This function can display a fatal popup form if the following errors occur: 21010002
Unigraphics reports error opening file%A%. Check part file, Path name, Version number and check run-time environment variables and/or support files.
21010007
A Unigraphics memory allocation error occurred. Unable to allocate memory.
21010009
An error occurred while closing the model. Filename =%A%.
This function can display an information popup form with the following messages:
Main Index
21010032
Opening UNIGRAPHICS database%A%
21010038
Completed UNIGRAPHICS database (%A%) access
21010091
Unigraphics Part File Version Number:%A%
21010070
Scanning for entities in layer number%I%
21010071
Processing entities in work layer
Chapter 2: Basic Functions 71 File Menu
This function will display a popup form that will provide a summary of the number of entities accessed from the Unigraphics part file. This function can display a popup form used to prompt the user for information about the global model tolerance. This function can display a warning popup message with the following text: 21010060
Missing one or more environment variables. The following MUST be set according to guidelines given in installation notes: OPENWINHOME (SUN4 ONLY), LD_LIBRARY_PATH(SUN4 ONLY), UGII_ROOT_DIR, UGII_FILE_SYSTEM, UGII_BASE_DIR, UGII_USERFCN, UGII_UGSOLIDS, UGII_SCHEMA, UGII_TERMMOD, UGII_06_FILE, UGII_10_FILE, UGII_CAM, UGII_UGCNCPT.
Example: Please see sgm_cad_access_v1 (p. 24) in the PCL Reference Manual Examples.
sgm_catia_access
(file_name, group_name, group_name_length, entity_toggle_values, simply_trimmed, color_toggle_values, all_layers, active_layer, layer_numbers, model_type, number_of_groups, group_entity_ids, group_entity_values, group_color_values, active_layer_values, layer_pointers, group_layers, interactive_flag, user_control_flag)
Description: This function is used to import a CATIA model geometry file but has no control over the model tolerance. Input:
Main Index
STRING
file_name[]
This value specifies the name of the path and the file to be imported.
STRING
group_name[80]
This value specifies the name of the group to which the imported geometry will be added. Currently, this value is ignored.
INTEGER
group_name_length
This value specifies the number of characters in the group_name input value. Currently, this value is ignored.
72 PCL Reference Manual File Menu
Main Index
LOGICAL
entity_toggle_values(18)
This value specifies an array used to select the geometry entity types to be imported where the offset into the array defines the entity type. The value at that offset will be set TRUE if that entity type is to be imported. Currently, these values are ignored.
LOGICAL
simply_trimmed
This value should be set to TRUE to import all surfaces as simple trimmed surfaces or to FALSE to import all surfaces as general trimmed surfaces. Currently, this value is ignored.
LOGICAL
color_toggle_values(14)
This value species an array that defines the overall color filter values. Currently, these values are ignored.
LOGICAL
all_layers
This value should be set to TRUE if all entities identified by the input value entity_toggle_values from all layers should be imported. Currently, this value is ignored.
LOGICAL
active_layer
This value should be set to TRUE if only the active or work layer entities will be imported. Currently, this value is ignored.
INTEGER
layer_numbers(256)
This value specifies an array that contains the layer values entered by the user for the overall layer filter. Currently, this value is ignored.
STRING
model_type[6]
This value specifies the CAD model type and should always be set to “catia”.
INTEGER
number_of_groups
This value specifies the number of groups defined. This input has a maximum value of 256. Currently, this value is ignored.
INTEGER
group_entity_ids(number_of_groups)
This value specifies the ID values for each user group. Currently, this value is ignored.
LOGICAL
group_entity_values(number_of_groups, 20)
This value specifies a two dimensional array that contains values set to TRUE if an entity is to be included and FALSE if an entity is not to be included in the group being imported. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the entity type. Currently, these values are ignored.
Chapter 2: Basic Functions 73 File Menu
LOGICAL
group_color_values(number_of_groups, 14)
This value specifies a two dimensional array that contains values set to TRUE if a color value is to be used. The offset in the first dimension of this array corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of this array identifies the color type. Currently, these values are ignored.
LOGICAL
active_layer_values(number_of_groups)
This value specifies an array that is used by setting the value at an offset that corresponds to the offset for the group id in the group_entity_values input value to TRUE if an entity in the active layer is included in the group identified by the offset into the array. Currently, these values are ignored.
INTEGER
layer_pointers(number_of_groups)
This value specifies an array that is used by setting a value at an offset that corresponds with the offset into the group_entity_ids input value that lists the group ids. The value at that offset in this array identifies the offset into the group_layers input value where the number of layer values for each group is stored. This array can store values that range from 1 to (512 number_of_groups). Currently, these values are ignored.
INTEGER
group_layers()
This value specifies an array used to identify the number of layers imported for each group. Currently these values are ignored, allowing the array to be any size.
INTEGER
interactive_flag
This value is used to indicate if the import of the file is to take place in batch mode. Currently, this value is ignored.
INTEGER
user_control_flag(2)
This value specifies an array where offset 1 is a flag indicating that duplicate geometric entities should always be created. This value should be initialized to 0 and should always be set to 0 if the value at offset 2 is set to 1. Offset 2 is a flag indicating that duplicate geometric entities should never be created. This value should be initialized to 0 and should always be set to 0 if the value at offset 1 is set to 1.
Output:
Main Index
74 PCL Reference Manual File Menu
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: This function does not provide any user input controls for the global model tolerance. Importing a CATIA model geometry file with control over the model tolerance can be done through the use of the function sgm_catia_access_v1. This function will provide an information display listing the percentage of each entity type being read into Patran from the CATIA model geometry file. The geometry read from the CATIA model geometry file will be entered into the Patran database and be shown on the display. Example: Please see sgm_catia_access (p. 26) in the PCL Reference Manual Examples.
sgm_catia_access_v1
(file_name, group_name, group_name_length,entity_toggle_values, simply_trimmed, enable_tol_prompt, color_toggle_values, all_layers, active_layer, layer_numbers, model_type, number_of_groups, group_entity_ids, group_entity_values, group_color_values, active_layer_values, layer_pointers, group_layers, interactive_flag, user_control_flag)
Description: This function is used to import a CATIA model geometry file while providing the user with control over the model tolerance. Input:
Main Index
STRING
file_name[]
This value specifies the name of the path and the file to be imported.
STRING
group_name[80]
This value specifies the name of the group to which the imported geometry will be added. Currently, this value is ignored.
Chapter 2: Basic Functions 75 File Menu
INTEGER
group_name_length
This value specifies the number of characters in the group_name input value. Currently, this value is ignored.
LOGICAL
entity_toggle_values(18)
This value specifies an array used to select the geometry entity types to be imported where the offset into the array defines the entity type. The value at that offset will be set TRUE if that entity type is to be imported. Currently, these values are ignored.
LOGICAL
simply_trimmed
This value should be set to TRUE to import all surfaces as simple trimmed surfaces or to FALSE to import all surfaces as general trimmed surfaces. Currently, this value is ignored.
LOGICAL
enable_tol_prompt
This value should be set to TRUE to enable prompting from the user for the global model tolerance or to FALSE to use the currently defined global model tolerance.
LOGICAL
color_toggle_values(14)
This value specifies an array that is used to set the overall color filter values. Currently, these values are ignored.
LOGICAL
all_layers
This value should be set to TRUE if all entities identified by the input value entity_toggle_values from all layers should be imported. Currently, this value is ignored.
LOGICAL
active_layer
This value should be set to TRUE if only the active or work layer entities will be imported. Currently, this value is ignored.
INTEGER
layer_numbers(256)
This value specifies an array that is used to set the layer values entered by the user for the overall layer filter. Currently, this value is ignored.
STRING
model_type[6]
This value specifies the CAD model type and should always be set to “catia”.
INTEGER
number_of_groups
This value specifies the number of groups defined. This input has a maximum value of 256.
INTEGER
group_entity_ids(number_of_groups) This value specifies an array that is used to set the
ID values for each user group. Currently, this value is ignored.
Main Index
76 PCL Reference Manual File Menu
Main Index
LOGICAL
group_entity_values(number_of_gro ups, 20)
This value specifies a two dimensional array that contains values set to TRUE if an entity is to be included and FALSE if an entity is not to be included in the group being imported. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the entity type. Currently, these values are ignored.
LOGICAL
group_color_values(number_of_grou ps, 14)
This value specifies a two dimensional array that contains values set to TRUE if a color value is to be used. The offset in the first dimension of this array corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of this array identifies the color type. Currently, these values are ignored.
LOGICAL
active_layer_values(number_of_grou ps)
This value specifies an array that is used by setting the value at an offset that corresponds to the offset for the group id in the group_entity_values input value to TRUE if an entity in the active layer is included in the group identified by the offset into the array. Currently, these values are ignored.
INTEGER
layer_pointers(number_of_groups)
This value specifies an array that is used by setting a value at an offset that corresponds with the offset into the group_entity_ids input value that lists the group ids. The value at that offset in this array identifies the offset into the group_layers input value where the number of layer values for each group is stored. This array can store values that range from 1 to (512 - number_of_groups). Currently, these values are ignored.
INTEGER
group_layers()
This value specifies an array used to identify the number of layers imported for each group. Currently these values are ignored, allowing the array to be any size.
INTEGER
interactive_flag
This value is used to indicate if the import of the file is to take place in batch mode. Currently, this value is ignored.
Chapter 2: Basic Functions 77 File Menu
INTEGER
user_control_flag(2)
This value specifies an array where offset 1 is a flag indicating that duplicate geometric entities should always be created. This value should be initialized to 0 and should always be set to 0 if the value at offset 2 is set to 1. Offset 2 is a flag indicating that duplicate geometric entities should never be created. This value should be initialized to 0 and should always be set to 0 if the value at offset 1 is set to 1.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: This function, sgm_catia_access_v1(), differs from the sgm_catia_access() function by providing the input value enable_tol_prompt to allow the user to have some control over the model tolerance used when the geometry file is imported. This function will provide an information display listing the percentage of each entity type being read into Patran from the CATIA model geometry file. The geometry read from the CATIA model geometry file will be entered into the Patran database and be shown in the current viewport. Example: Please see sgm_catia_access_v1 (p. 28) in the PCL Reference Manual Examples.
Main Index
78 PCL Reference Manual File Menu
sgm_catia_import
( file_name, simple_trim, solid_type, enable_tol_prompt )
Description: This function will import CATXPRES catia geometry objects. Input: STRING
file_name[]
This value specifies the name of the CATXPRES file to import.
LOGICAL
simple_trim
This value specifies, when set to TRUE, that the Catia surfaces will be converted to Patran simple trimmed surfaces. When set to FALSE, the Catia surfaces will be converted to Patran general trimmed surfaces.
INTEGER
solid_Type
This value specifes, when set to 1 that all solids will be converted to Patran brep solids. When this value is set to 2, all solids will be converted to Patran triparametric solids.
LOGICAL
enable_tol_prompt
This value specifies, when set to TRUE, to prompt users to decide to use the Patran default or model tolerance. When set to FALSE, the Patran model tolerance will be used.
Output: INTEGER
Error Conditions: None. Remarks: None Example: None
Main Index
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Chapter 2: Basic Functions 79 File Menu
sgm_euclid_access
(file_name, group_name, group_name_length,entity_toggle_values, simply_trimmed, color_toggle_values, all_layers, active_layer, layer_numbers, model_type, number_of_groups, group_entity_ids, group_entity_values, group_color_values, active_layer_values, layer_pointers, group_layers, interactive_flag, user_control_flag)
Description: This function is used to import a EUCLID model geometry file but has no control over the model tolerance. Input:
Main Index
STRING
file_name[]
This value specifies the name of the path and the file to be imported.
STRING
group_name[80]
This value specifies the name of the group to which the imported geometry will be added. Currently, this value is ignored.
INTEGER
group_name_length
This value specifies the number of characters in the group_name input value. Currently, this value is ignored.
LOGICAL
entity_toggle_values(18)
This value specifies an array used to select the geometry entity types to be imported where the offset into the array defines the entity type. The value at that offset will be set TRUE if that entity type is to be imported. Currently, these values are ignored.
LOGICAL
simply_trimmed
This value should be set to TRUE to import all surfaces as simple trimmed surfaces or to FALSE to import all surfaces as general trimmed surfaces. Currently, this value is ignored.
LOGICAL
color_toggle_values(14)
This value specifies an array that is used to set the overall color filter values. Currently, these values are ignored.
LOGICAL
all_layers
This value should be set to TRUE if all entities identified by the input value entity_toggle_values from all layers should be imported. Currently, this value is ignored.
80 PCL Reference Manual File Menu
LOGICAL
active_layer
This value should be set to TRUE if only the active or work layer entities will be imported. Currently, this value is ignored.
INTEGER
layer_numbers(256)
This value specifies an array that is used to set the layer values entered by the user for the overall layer filter. Currently, this value is ignored.
STRING
model_type[6]
This value specifies the CAD model type and should always be set to “euclid”.
INTEGER
number_of_groups
This value specifies the number of groups defined. This input has a maximum value of 256. Currently, this value is ignored.
INTEGER
group_entity_ids(number_of_groups) This value specifies an array that is used to set the ID
values for each user group. Currently, this value is ignored.
Main Index
LOGICAL
group_entity_values(number_of_gro ups, 20)
This value specifies a two dimensional array that contains values set to TRUE if an entity is to be included and FALSE if an entity is not to be included in the group being imported. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the entity type. Currently, these values are ignored.
LOGICAL
group_color_values(number_of_grou ps, 14)
This value specifies a two dimensional array that contains values set to TRUE if a color value is to be used. The offset in the first dimension of this array corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of this array identifies the color type. Currently, these values are ignored.
LOGICAL
active_layer_values(number_of_grou ps)
This value specifies an array that is used by setting the value at an offset that corresponds to the offset for the group id in the group_entity_values input value to TRUE if an entity in the active layer is included in the group identified by the offset into the array. Currently, these values are ignored.
Chapter 2: Basic Functions 81 File Menu
INTEGER
layer_pointers(number_of_groups)
This value specifies an array that is used by setting a value at an offset that corresponds with the offset into the group_entity_ids input value that lists the group ids. The value at that offset in this array identifies the offset into the group_layers input value where the number of layer values for each group is stored. This array can store values that range from 1 to (512 - number_of_groups). Currently, these values are ignored.
INTEGER
group_layers()
This value specifies an array used to identify the number of layers imported for each group. Currently these values are ignored, allowing the array to be any size.
INTEGER
interactive_flag
This value is used to indicate if the import of the file is to take place in batch mode. Currently, this value is ignored.
INTEGER
user_control_flag(2)
This value specifies an array where offset 1 is a flag indicating that duplicate geometric entities should always be created. This value should be initialized to 0 and should always be set to 0 if the value at offset 2 is set to 1. Offset 2 is a flag indicating that duplicate geometric entities should never be created. This value should be initialized to 0 and should always be set to 0 if the value at offset 1 is set to 1.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: This function does not provide any user input controls for the global model tolerance. Importing a EUCLID model geometry file with control over the model tolerance can be done through the use of the sgm_euclid_access_v1 function. This function will provide an information display listing the percentage of each entity type being read into Patran from the EUCLID model geometry file. The geometry read from the EUCLID model geometry file will be entered into the Patran database and be shown on the display.
Main Index
82 PCL Reference Manual File Menu
Example: Please see sgm_euclid_access (p. 30) in the PCL Reference Manual Examples.
sgm_euclid_access_v1
(file_name, group_name, group_name_length,entity_toggle_values, simply_trimmed, enable_tol_prompt, color_toggle_values, all_layers, active_layer, layer_numbers, model_type, number_of_groups, group_entity_ids, group_entity_values, group_color_values, active_layer_values, layer_pointers, group_layers, interactive_flag, user_control_flag)
Description: This function is used to import a EUCLID model geometry file while providing the user with control over the model tolerance. Input:
Main Index
STRING
file_name[]
This value specifies the name of the path and the file to be imported.
STRING
group_name[80]
This value specifies the name of the group to which the imported geometry will be added. Currently, this value is ignored.
INTEGER
group_name_length
This value specifies the number of characters in the group_name input value. Currently, this value is ignored.
LOGICAL
entity_toggle_values(18)
This value specifies an array used to select the geometry entity types to be imported where the offset into the array defines the entity type. The value at that offset will be set TRUE if that entity type is to be imported. Currently, these values are ignored.
LOGICAL
simply_trimmed
This value should be set to TRUE to import all surfaces as simple trimmed surfaces or to FALSE to import all surfaces as general trimmed surfaces. Currently, this value is ignored.
LOGICAL
enable_tol_prompt
This value should be set to TRUE to enable prompting from the user for the global model tolerance or to FALSE to use the currently defined global model tolerance.
Chapter 2: Basic Functions 83 File Menu
Main Index
LOGICAL
color_toggle_values(14)
This value specifies an array that is used to set the overall color filter values. Currently, these values are ignored.
LOGICAL
all_layers
This value should be set to TRUE if all entities identified by the input value entity_toggle_values from all layers should be imported. Currently, this value is ignored.
LOGICAL
active_layer
This value should be set to TRUE if only the active or work layer entities will be imported. Currently, this value is ignored.
INTEGER
layer_numbers(256)
This value specifies an array that is used to set the layer values entered by the user for the overall layer filter. Currently, this value is ignored.
STRING
model_type[6]
This value specifies the CAD model type and should always be set to “euclid”.
INTEGER
number_of_groups
This value specifies the number of groups. This input value has a maximum value of 256. Currently, this value is ignored.
INTEGER
group_entity_ids(number_ of_groups)
This array specifies the ID values for each user group. Currently, this value is ignored.
LOGICAL
group_entity_values(numb er_of_groups, 20)
This value specifies a two dimensional array that contains values set to TRUE if an entity is to be included and FALSE if an entity is not to be included in the group being imported. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the entity type. Currently, these values are ignored.
LOGICAL
group_color_values(numbe This value specifies a two dimensional array that r_of_groups, 14) contains values set to TRUE if a color value is to be used. The offset in the first dimension of this array corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of this array identifies the color type. Currently, these values are ignored.
LOGICAL
active_layer_values(numbe This value specifies an array that is used by setting r_of_groups) the value at an offset that corresponds to the offset for the group id in the group_entity_values input value to TRUE if an entity in the active layer is included in the group identified by the offset into the array. Currently, these values are ignored.
84 PCL Reference Manual File Menu
INTEGER
layer_pointers(number_of_ This value specifies an array that is used by setting a groups) value at an offset that corresponds with the offset into the group_entity_ids input value that lists the group ids. The value at that offset in this array identifies the offset into the group_layers input value where the number of layer values for each group is stored. This array can store values that range from 1 to (512 number_of_groups). Currently, these values are ignored.
INTEGER
group_layers()
This value specifies an array used to identify the number of layers imported for each group. Currently these values are ignored, allowing the array to be any size.
INTEGER
interactive_flag
This value is used to indicate if the import of the file is to take place in batch mode. Currently, this value is ignored.
INTEGER
user_control_flag(2)
This value specifies an array where offset 1 is a flag indicating that duplicate geometric entities should always be created. This value should be initialized to 0 and should always be set to 0 if the value at offset 2 is set to 1. Offset 2 is a flag indicating that duplicate geometric entities should never be created. This value should be initialized to 0 and should always be set to 0 if the value at offset 1 is set to 1.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: None. This is only a partial list of the error values that can be returned by this function. 1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: This function, sgm_euclid_access_v1(), differs from the sgm_euclid_access() function by providing the input value enable_tol_prompt to allow the user to have some control over the model tolerance used when the geometry file is imported.
Main Index
Chapter 2: Basic Functions 85 File Menu
This function will provide an information display listing the percentage of each entity type being read into Patran from the EUCLID model geometry file. The geometry read from the EUCLID model geometry file will be entered into the Patran database and be shown in the current viewport. Example: Please see sgm_euclid_access_v1 (p. 31) in the PCL Reference Manual Examples.
sgm_ptc_access_v2
(file_name, file_type, simply_trimmed, create_groups, save_geo_file, enable_tol_prompt, pro_entities, pro_count, patran_count)
Description: This function is used to import a Pro/ENGINEER model geometry file. Input: STRING
file_name[]
This value specifies the name of the path and the file to be imported.
STRING
file_type[3]
This value specifies the geometry file type and can have the following case insensitive values: “PRT”, “ASM”, and “GEO”.
LOGICAL
simply_trimmed
This value should be set to TRUE to import all surfaces as simple trimmed surfaces or to FALSE to import all surfaces as general trimmed surfaces.
LOGICAL
create_groups
LOGICAL
save_geo_file
This value should be set to TRUE if the .geo file is to be saved after accessing the .prt or .asm file.
LOGICAL
enable_tol_prompt
This value should be set to TRUE to enable prompting from the user for the global model tolerance or to FALSE to use the currently defined global model tolerance.
INTEGER
pro_entities (17)
This value specifies the Pro/ENGINEER entities to access. See the remarks below for more information.
pro_count(9)
This value returns an array listing the counts of Pro/ENGINEER entities that were in the imported file versus the counts of entities that were processed. See the remarks below for more information.
This value should be set to TRUE if Patran groups are to be created from Pro/ENGINEER parts in an assembly listed in the imported file.
Output: INTEGER
Main Index
86 PCL Reference Manual File Menu
INTEGER
patran_count(7)
This value returns an array listing the number of Patran entities created. See the remarks below for more information.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: The input value file_type can have the following values: “PRT”, “ASM”, “GEO”. This string value is not case sensitive. The input value pro_entities uses offset 1 to specify the number of entities. Offsets 2 through 17 can be set to a value that identifies the entity type: Entity type
Main Index
Array value
Solid Face
1
Datum Point
2
Datum Curve
3
Datum Surface
4
Plane
108
Spline Surface
114
Ruled Surface
118
Surface of Revolution
120
Tabulated Cylinder
122
B_Spline Surface
128
Cylinder
154
Cone
156
Torus
160
Coons Patch
170
Fillet Surface
172
Cylindrical Spline Surface
174
Chapter 2: Basic Functions 87 File Menu
The integer output array pro_count returns values where the offsets identify the following type of entities Array offset
Entity type
1
Face Count
2
Point Count
3
Curve Count
4
Surface Count
5
Number of parts
6
Number of faces Processed
7
Number of points Processed
8
Number of curves Processed
9
Number of surfaces Processed
The integer output array patran_count returns values where the offsets identify the following type of entities: Array offset
Entity type
1
Trimmed Surface Count
2
Number of points Processed
3
Number of curves Processed
4
Number of surfaces Processed
5
The Parent Surface Count
6
Trimmed Curve Count
7
Number of groups
This function will import model geometry from the specified file, place it in the database and display it in the current viewport. This function can display fatal popup forms with the following messages: 38000802
Unable to acquire Pro/ENGINEER Geometry file size.
38000803
Unable to read Pro/ENGINEER Geometry file%A%.
38000805
Unable to acquire%I% words of virtual memory.
38000819
The file type%A% is not a valid Pro/ENGINEER file type. Input either PRT, ASM, or GEO.
This function can display informational popup forms with the following messages:
Main Index
88 PCL Reference Manual File Menu
38000821
Importing Pro/ENGINEER Part File.
38000823
Adding geometry to group%A%.
38000826
Patran ProENGINEER Access Model Import Terminated.
This function can display warning popup forms with the following messages: 38000828
A total of%I% surface contours were not closed in real (3D) space. The maximum gap distance was%G%. Try setting the Global Model Tolerance in the Global Preferences to a value greater than the gap distance and try again.
This function displays a warning popup form showing the message associated with the status value returned by the function: ga_group_current_set() Example: Please see sgm_ptc_access_v2 (p. 35) in the PCL Reference Manual Examples.
sgm_ptc_access_v4
(file_name, file_type, simply_trimmed, create_groups, save_geo_file, tol_prompt_on, as_solid, pro_entities, pro_count, patran_count)
Description: This function is used to import a Pro/ENGINEER model geometry file. Input:
Main Index
STRING
file_name[]
This value specifies the name of the path and the file to be imported.
STRING
file_type[3]
This value specifies the geometry file type and can have the following case insensitive values: “PRT”, “ASM”, and “GEO”.
LOGICAL
simply_trimmed
This value should be set to TRUE to import all surfaces as simple trimmed surfaces or to FALSE to import all surfaces as general trimmed surfaces.
LOGICAL
create_groups
LOGICAL
save_geo_file
This value should be set to TRUE if Patran groups are to be created from Pro/ENGINEER parts in an assembly listed in the imported file. This value should be set to TRUE if the .geo file is to be saved after accessing the .prt or .asm file.
Chapter 2: Basic Functions 89 File Menu
LOGICAL
tol_prompt_on
This value should be set to TRUE to enable prompting from the user for the global model tolerance or to FALSE to use the currently defined global model tolerance.
LOGICAL
as_solid
This value should be set to TRUE if a B-rep is to be imported as a Solid or to FALSE if a B-rep is to be imported as a set of constituent surfaces.
INTEGER
pro_entities (19)
This value specifies the Pro/ENGINEER entities to access. See the remarks below for more information.
INTEGER
pro_count(13)
This value returns an array listing the counts of Pro/ENGINEER entities that were in the imported file versus the counts of entities that were processed. See the remarks below for more information.
INTEGER
patran_count(10)
This value returns an array listing the number of
Output:
Patran entities created. See the remarks below for more information. INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: The input value file_type can have the following values: “PRT”, “ASM”, “GEO”. This string value is not case sensitive. The input value pro_entities uses offset 1 to specify the number of entities. Offsets 2 through 17 can be set to a value that identifies the entity type: Entity type
Main Index
Array value
Solid Face
10
Datum Point
1
Datum Curve
2
Datum Surface
4
90 PCL Reference Manual File Menu
Datum Plane
8
Coord Sys Datum
16
Plane
108
Spline Surface
114
Ruled Surface
118
Surface of Revolution
120
Tabulated Cylinder
122
B_Spline Surface
128
Cylinder
154
Cone
156
Torus
160
Coons Patch
170
Fillet Surface
172
Cylindrical Spline Surface
174
The integer output array pro_count returns values where the offsets identify the following type of entities :
Array offset
Entity type
1
Face count
2
Point count
3
Curve count
4
Surface count
5
Plane count
6
Coordinate System count
7
Number of parts
8
Number of faces processed
9
Number of points processed
10
Number of curves processed
11
Number of surfaces processed
12
Number of planes processed
13
Number of coordinate systems processed
The integer output array patran_count returns values where the offsets identify the following type of entities:
Main Index
Chapter 2: Basic Functions 91 File Menu
Array offset
Entity type
1
Trimmed Surface count
2
Number of points processed
3
Number of curves processed
4
Number of surfaces processed
5
The Solid count
6
Number of planes processed
7
Number of coordinate systems processed
8
The Parent Surface count
9
Trimmed Curve count
10
Number of groups
This function will import model geometry from the specified file, place it in the database and display it in the current viewport. This function can display fatal popup forms with the following messages: 38000802
Unable to acquire Pro/ENGINEER Geometry file size.
38000803
Unable to read Pro/ENGINEER Geometry file%A%.
38000805
Unable to acquire%I% words of virtual memory.
38000819
The file type%A% is not a valid Pro/ENGINEER file type. Input either PRT, ASM, or GEO.
This function can display informational popup forms with the following messages: 38000821
Importing Pro/ENGINEER Part File.
38000823
Adding geometry to group%A%.
38000826
Patran ProENGINEER Access Model Import Terminated.
This function can display warning popup forms with the following messages: 38000828
A total of%I% surface contours were not closed in real (3D) space. The maximum gap distance was%G%. Try setting the Global Model Tolerance in the Global Preferences to a value greater than the gap distance and try again.
This function displays a warning popup form showing the message associated with the status value returned by the function: ga_group_current_set()
Main Index
92 PCL Reference Manual File Menu
Example: None.
Main Index
Chapter 2: Basic Functions 93 File Menu
sgm_ptc_access_v5
(file_name, file_type, simply_trimmed, create_groups, save_geo_file, tol_prompt_on, as_solid, pro_entities, pro_count, patran_count)
Description: This function is used to import a Pro/ENGINEER model geometry file. Input: STRING
file_name[]
This value specifies the name of the path and the file to be imported.
STRING
file_type[3]
This value specifies the geometry file type and can have the following case insensitive values: “PRT”, “ASM”, and “GEO”.
LOGICAL
simply_trimmed
This value should be set to TRUE to import all surfaces as simple trimmed surfaces or to FALSE to import all surfaces as general trimmed surfaces.
LOGICAL
create_groups
LOGICAL
save_geo_file
This value should be set to TRUE if the .geo file is to be saved after accessing the .prt or .asm file.
LOGICAL
tol_prompt_on
This value should be set to TRUE to enable prompting from the user for the global model tolerance or to FALSE to use the currently defined global model tolerance.
LOGICAL
as_solid
This value should be set to TRUE if a B-rep is to be imported as a Solid or to FALSE if a B-rep is to be imported as a set of constituent surfaces.
INTEGER
pro_entities (20)
This value specifies the Pro/ENGINEER entities to access. See the remarks below for more information.
INTEGER
pro_count(15)
This value returns an array listing the counts of Pro/ENGINEER entities that were in the imported file versus the counts of entities that were processed. See the remarks below for more information.
INTEGER
patran_count(11)
This value should be set to TRUE if Patran groups are to be created from Pro/ENGINEER parts in an assembly listed in the imported file.
Output:
Main Index
This value returns an array listing the number of Patran entities created. See the remarks below for more information.
94 PCL Reference Manual File Menu
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: The input value file_type can have the following values: “PRT”, “ASM”, “GEO”. This string value is not case sensitive. The input value pro_entities uses offset 1 to specify the number of entities. Offsets 2 through 17 can be set to a value that identifies the entity type: Entity type
Main Index
Array value
Solid Face
10
Datum Point
1
Datum Curve
2
Datum Surface
4
Datum Plane
8
Coord Sys Datum
16
Material
32
Plane
108
Spline Surface
114
Ruled Surface
118
Surface of Revolution
120
Tabulated Cylinder
122
B_Spline Surface
128
Cylinder
154
Cone
156
Torus
160
Coons Patch
170
Fillet Surface
172
Cylindrical Spline Surface
174
Chapter 2: Basic Functions 95 File Menu
The integer output array pro_count returns values where the offsets identify the following type of entities Array offset
Entity type
1
Face count
2
Point count
3
Curve count
4
Surface count
5
Plane count
6
Coordinate System count
7
Material count
8
Number of parts
9
Number of faces processed
10
Number of points processed
11
Number of curves processed
12
Number of surfaces processed
13
Number of planes processed
14
Number of coordinate systems processed
15
Number of materials processed
The integer output array patran_count returns values where the offsets identify the following type of entities: Array offset
Main Index
Entity type
1
Trimmed Surface count
2
Number of points processed
3
Number of curves processed
4
Number of surfaces processed
5
The Solid count
6
Number of planes processed
7
Number of coordinate systems processed
8
The Parent Surface count
9
Trimmed Curve count
10
Number of groups
11
Number of materials processed
96 PCL Reference Manual File Menu
This function will import model geometry from the specified file, place it in the database and display it in the current viewport. This function can display fatal popup forms with the following messages: 38000802
Unable to acquire Pro/ENGINEER Geometry file size.
38000803
Unable to read Pro/ENGINEER Geometry file%A%.
38000805
Unable to acquire%I% words of virtual memory.
38000819
The file type%A% is not a valid Pro/ENGINEER file type. Input either PRT, ASM, or GEO.
This function can display informational popup forms with the following messages: 38000821
Importing Pro/ENGINEER Part File.
38000823
Adding geometry to group%A%.
38000826
Patran ProENGINEER Access Model Import Terminated.
This function can display warning popup forms with the following messages: 38000828
A total of%I% surface contours were not closed in real (3D) space. The maximum gap distance was%G%. Try setting the Global Model Tolerance in the Global Preferences to a value greater than the gap distance and try again.
38000847
The Material assigned to part %A% in Pro/ENGINEER was not written to the Patran database because a solid did not get created.
38000848
Error occurred ateempting to write the Material %A% assigned to aprt %A% in Pro/ENGINEER to solid %l% in the Patran database.
This function displays a warning popup form showing the message associated with the status value returned by the function: ga_group_current_set() Example: None
Main Index
Chapter 2: Basic Functions 97 File Menu
uil_db_commit
(command)
Description: This function will submit the last database transaction so that it cannot be undone and set the description string to be used with the undone operation. Input: STRING
command[]
This value specifies a description of current command to be used in the message when the command is undone.
Output: None. Error Conditions: None. Remarks: The results of prior database operations are set so that only the database transactions from this point on can be undone. This routine should be called in the callback for the “Apply” button in a popup form used to control an application or at the beginning of a logical command. Example: Please see uil_db_commit (p. 36) in the PCL Reference Manual Examples.
uil_db_undo
()
Description: This function will undo the last database transaction. Input: None. Output: None. Error Conditions: None. Remarks: All database operations done since the last call to the uil_db_commit() function will be thrown away. The recording session file will be updated from the point of the last call to the uil_db_commit() function.
Main Index
98 PCL Reference Manual File Menu
Example: Please see uil_db_undo (p. 37) in the PCL Reference Manual Examples.
uil_file_close.go
()
Description: This function will close a database. Input: None. Output: None. Error Conditions: None. Remarks: Executing this function will close all viewports and forms with the exception of the main form. Example: Please see uil_file_close.go (p. 38) in the PCL Reference Manual Examples.
uil_file_new.go
(template_name, file_name)
Description: This function will create and open a new database using the specified database and template file name. Input: STRING
template_name[256]
This value specifies the name of database to be used as the template. If this value is set to “”, the P3_HOME/template.db file will be used.
STRING
file_name[256]
This value specifies the name of the database to be created.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
Chapter 2: Basic Functions 99 File Menu
8111002
File%A% is in use by another user. Opening this database may cause undesirable results. Do you wish to continue anyway?
36000001
Cannot open database%A%.A database is already open.
36000002
Database%A% already exists.Do you wish to delete the existing database and create a new one?
Remarks: Using this function to create databases across machine-type boundaries is not recommended. The database files created by this function may not be compatible from machine type to machine type. This function can display yes/no query popup forms with the messages: 8111002
File%A% is in use by another user. Opening this database may cause undesirable results. Do you wish to continue anyway?
36000002
Database%A% already exists. Do you wish to delete the existing database and create a new one?
This function can display a fatal popup form with the message: 36000001
Cannot open database%A%.A database is already open.
This function will write comments to the journal and session files. Example: Please see uil_file_new.go (p. 39) in the PCL Reference Manual Examples.
uil_file_open.go
(file_name)
Description: This function will open a database. Input: STRING
file_name[256]
This value specifies the name of the database to open.
Output: None. Error Conditions: This is only a partial list of the error values that can be returned by this function. 8111002
Main Index
File%A% is in use by another user. Opening this database may cause undesirable results. Do you wish to continue anyway?
100 PCL Reference Manual File Menu
36000001
Cannot open database%A%.A database is already open.
36000002
Database%A% already exists.Do you wish to delete the existing database and create a new one?
36000003
Database%A% does not exist.Do you wish to create a new database?
Remarks: Using this function to open a database created on a machine of a different type is not recommended. This function can display a fatal popup form with the message: 36000001
Cannot open database%A%.A database is already open.
This function can display a warning popup form with the message: 39000004
Journal file%A% does not exist. No journal file will be created.
This function can display yes/no query popup forms with the messages: 36000003
Database%A% does not exist.Do you wish to create a new database?
This function may not be able to open database files that have been transferred from one machine type to another. A viewport for the loaded database file will be displayed and the preferences will be set using information from the opened database. Example: Please see uil_file_open.go (p. 40) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 101 File Menu
uil_imaging_coordframes.post_cf
(contents)
Description: This function will post the selected coordinate frames to all viewports. Input: STRING
contents[]
This value specifies a list of coordinate frame identifiers to post to all viewports.
Output: None. Error Conditions: None Remarks: This function can display a warning popup form with the message: 11005001
Global Coordinate Frame 0 (Global Axes Display) is controlled per viewport via the Viewport Modify form.
This function can display a fatal popup form with the following messages: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function calls and can display the status value returned by the following function in a warning popup form. db_post_coord() This function calls but does not return the status values returned by the following functions: app_get_handle() app_next_label() Example: Please see uil_imaging_coordframes.post_cf (p. 40) in the PCL Reference Manual Examples.
Main Index
102 PCL Reference Manual File Menu
uil_imaging_coordframes.unpost_cf
(contents)
Description: This function will unpost the selected coordinate frames to all viewports. Input: STRING
contents[]
This value specifies a list of coordinate frame identifiers to unpost from all viewports.
Output: None. Error Conditions: None. Remarks: This function can display a fatal popup form with the following messages: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function can display a warning popup form with the message: 11005001
Global Coordinate Frame 0 (Global Axes Display) is controlled per viewport via the Viewport Modify form.
This function calls but does not return the status values returned by the following functions: app_get_handle() app_next_label() Example: Please see uil_imaging_coordframes.unpost_cf (p. 42) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 103 File Menu
uil_primary.get_menubar_id
()
Description: This function returns the widget value for the Patran menu bar. Input: None. Output: widget
This value returns the widget identifier for the main menu bar.
Error Conditions: None. Remarks: This function can be called from or after the p3epilog.pcl start-up file has been run by the init.pcl file. Calling it before the p3epilog.pcl file has been run may cause allow an invalid widget id to be returned. Example: Please see uil_primary.get_menubar_id (p. 43) in the PCL Reference Manual Examples.
uil_viewport_tiling.tile
()
Description: This function tiles or places in a side by side arrangement up to four posted viewports. Input: None. Output: None. Error Conditions: None. Remarks: This function will display a warning popup form with the following message if more than four viewports are posted:
Main Index
104 PCL Reference Manual File Menu
11003004
Unable to tile more than 4 Viewports.
This function will display a fatal popup form listing the message associated with the status returned by the following functions: ga_viewport_location_get() ga_viewport_location_set() ga_viewport_nposted_get() ga_viewport_posted_get() ga_viewport_size_set() This function will return immediately if Patran is being run in batch mode. Example: Please see uil_viewport_tiling.tile (p. 43) in the PCL Reference Manual Examples.
ugi_export_iges
(file_name, start_section, model_units, entity_values, all_groups, number_of_groups, group_entity_ids, patran_count, iges_count)
Description: This function exports Patran geometry information from the database to a file in the IGES standard file format. Input: STRING
file_name[]
This value specifies the name of the path and the file to be created.
STRING
start_section[]
This value specifies the IGES file start section prolog lines.
STRING
model_units[]
This value specifies the IGES file model units.
LOGICAL
entity_values(7)
This value specifies the entity type filter status flags used to specify which Patran entity types will be exported to the IGES file.
Main Index
LOGICAL
all_groups
INTEGER
number_of_groups
INTEGER
group_entity_ids(num ber_of_groups)
This value is set to TRUE if all groups are to be exported to the IGES file. This value specifies the number of Patran groups to be exported to the IGES file. This value specifies an array containing the IDs of the Patran groups to be exported to the IGES file.
Chapter 2: Basic Functions 105 File Menu
Output: INTEGER
patran_count(7)
INTEGER
iges_count(20)
This value returns the number of IGES entities created by type.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
This value returns a list of the number of Patran entities processed from the database by type.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
Main Index
This is an internal status condition. There is no corresponding status message in the message database.
106 PCL Reference Manual File Menu
Remarks: This function can display information popup forms with the following messages: 38000597
Exporting%I% Patran Elements.
38000602
Creating%I% IGES file Parameter Data Records.
38000607
Exporting%I% Patran Elements by Group.
This function can display fatal popup forms with the following messages: 38000504
Unable to open scratch file.
38000505
Unable to open IGES file%A%.
38000805
Unable to acquire%I% words of virtual memory.
This function can display a query popup form with the following message: 36000005
%A% File%A% already exists.Do you wish to delete the existing%A% file and create a new one?
This function can display fatal popup forms listing the messages associated with the status values returned by a call to the function: file_delete() Example: None
Main Index
Chapter 2: Basic Functions 107 File Menu
ugi_export_iges_v1
(file_name, start_section, nlpos, nlknt, product_id, author, author_org, model_units, entity_values, all_groups, number_of_groups, group_entity_ids, patran_count, iges_count)
Description: This function exports Patran geometry information from the database to a file in the IGES standard file format. Input: STRING
file_name[]
This value specifies the name of the path and the file to be created.
STRING
start_section[]
This value specifies the IGES file start section prolog lines.
INTEGER
nlpos(*)
New line character (\n) positions in Start Section.
INTEGER
nlknt
Number of new line characters (\n) in Start Section.
STRING
product_id
Product Id for receiving system
STRING
author
Author
STRING
author_org
Author’s Organization
STRING
model_units[]
This value specifies the IGES file model units.
LOGICAL
entity_values(8)
This value specifies the entity type filter status flags used to specify which Patran entity types will be exported to the IGES file.
LOGICAL
all_groups
This value is set to TRUE if all groups are to be exported to the IGES file.
INTEGER
number_of_groups
INTEGER
group_entity_ids(number This value specifies an array containing the IDs of the _of_groups) Patran groups to be exported to the IGES file.
This value specifies the number of Patran groups to be exported to the IGES file.
Output:
Main Index
INTEGER
patran_count(8)
INTEGER
iges_count(21)
This value returns a list of the number of Patran entities processed from the database by type. This value returns the number of IGES entities created by type.
108 PCL Reference Manual File Menu
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: This function can display information popup forms with the following messages: 38000597
Exporting%I% Patran Elements.
38000602
Creating%I% IGES file Parameter Data Records.
38000607
Exporting%I% Patran Elements by Group.
This function can display fatal popup forms with the following messages: 38000504
Unable to open scratch file.
38000505
Unable to open IGES file%A%.
38000805
Unable to acquire%I% words of virtual memory.
This function can display a query popup form with the following message: 36000005
%A% File%A% already exists.Do you wish to delete the existing%A% file and create a new one?
This function can display fatal popup forms listing the messages associated with the status values returned by a call to the function: Example: None
Main Index
Chapter 2: Basic Functions 109 File Menu
ugi_export_iges_v2
(file_name, start_section, product_id, author, author_org, model_units, entity_values, all_groups, number_of_groups, group_entity_ids, patran_count, iges_count)
Description: This function exports Patran geometry information from the database to a file in the IGES standard file format. Input: STRING
file_name[]
This value specifies the name of the path and the file to be created.
STRING
start_section[]
This value specifies the IGES file start section prolog lines.
STRING
product_id
Product Id for receiving system
STRING
author
Author
STRING
author_org
Author’s Organization
STRING
model_units[]
This value specifies the IGES file model units.
LOGICAL
entity_values(8)
This value specifies the entity type filter status flags used to specify which Patran entity types will be exported to the IGES file.
LOGICAL
all_groups
INTEGER
number_of_groups
INTEGER
group_entity_ids(nu mber_of_groups)
This value is set to TRUE if all groups are to be exported to the IGES file. This value specifies the number of Patran groups to be exported to the IGES file. This value specifies an array containing the IDs of the Patran groups to be exported to the IGES file.
Output: INTEGER
patran_count(8)
INTEGER
iges_count(21)
This value returns the number of IGES entities created by type.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
This value returns a list of the number of Patran entities processed from the database by type.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
Main Index
This is an internal status condition. There is no corresponding status message in the message database.
110 PCL Reference Manual File Menu
Remarks: This function can display information popup forms with the following messages: 38000597
Exporting%I% Patran Elements.
38000602
Creating%I% IGES file Parameter Data Records.
38000607
Exporting%I% Patran Elements by Group.
This function can display fatal popup forms with the following messages: 38000504
Unable to open scratch file.
38000505
Unable to open IGES file%A%.
38000805
Unable to acquire%I% words of virtual memory.
This function can display a query popup form with the following message: 36000005
%A% File%A% already exists.Do you wish to delete the existing%A% file and create a new one?
This function can display fatal popup forms listing the messages associated with the status values returned by a call to the function: Example: None
Main Index
Chapter 2: Basic Functions 111 File Menu
ugi_import_iges
(file_name, group_name, entity_toggle_values, color_toggle_values, color_method, color_definition, all_layers, layer, number_of_groups, group_entity_ids, group_entity_values, group_color_values, layer_pointers, group_layers, scale, iges_count, patran_count)
Description: This function imports geometry information from a file in the IGES standard file format into the Patran database. Input:
Main Index
STRING
file_name[]
This value specifies the name of the path and the file to be imported.
STRING
group_name[31]
This value specifies the name of the group to which the imported geometry will be added.
LOGICAL
entity_toggle_values(23)
This value specifies the entity type filter status flags to specify which IGES entity types to import.
LOGICAL
color_toggle_values(9)
This value defined the entity color filter status flags to specify which IGES entity colors to import.
STRING
color_method[7]
This value is used to specify the color definition entity method used to import color definition entities.
STRING
color_definition[]
This value specifies the color definition entities to import.
LOGICAL
all_layers
This value should be set to TRUE if all geometry layers are to be imported.
STRING
layer[]
This value specifies a string that is used to specify the geometry layers to be imported.
INTEGER
number_of_groups
This value is the number of groups defined.
INTEGER
group_entity_ids(number_ of_groups)
This array specifies the ID values for each user group.
LOGICAL
group_entity_values(20, number_of_groups)
This value specifies a two dimensional array that contains values set to TRUE if an entity is to be included and FALSE if an entity is not to be included in the group being imported. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the entity type.
112 PCL Reference Manual File Menu
LOGICAL
group_color_values(10, number_of_groups)
This value specifies a two dimensional array that contains values set to TRUE if a color value is to be used. The offset in the first dimension of this array corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of this array identifies the color type.
INTEGER
layer_pointers(number_of_ This value specifies an array that is used by setting a groups) value at an offset that corresponds with the offset into the group_entity_ids input value that lists the group ids. The value at that offset in this array identifies the offset into the group_layers input value where the number of layer values for each group is stored. The maximum value allowed for this array is equal to the number of integers in the group_layers input value.
INTEGER
group_layers()
This value specifies an array used to identify the number of layers imported for each group. The size of this array must be equal to or greater than the largest value placed in the layer_pointers input value.
REAL
scale
This value returns the IGES file model space scale.
INTEGER
iges_count(20)
This value returns the number of IGES entities imported by type.
INTEGER
patran_count(8)
INTEGER
Output:
This value returns the number of Patran entities written to the database by type. This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: The input value color_method can have a value of “ALL”, “NONE”, or “SPECIFY”. This function will provide information popup forms that list the number of IGES entities imported and Patran entities created.
Main Index
Chapter 2: Basic Functions 113 File Menu
The geometric entities placed in the Patran database will be displayed in the viewport. Example: Please see ugi_import_iges (p. 44) in the PCL Reference Manual Examples.
ugi_import_iges_v4
(file_name, group_name, entity_toggle_values, color_toggle_values, color_method, color_definition, all_layers, layer, number_of_groups, group_entity_ids, group_entity_values, group_color_values, layer_pointers, group_layers, scale, iges_count, patran_count)
Description: This function imports geometry information from a file in the IGES standard file format into the Patran database. Input: STRING
file_name[]
This value specifies the name of the path and the file to be imported.
INTEGER
ipref142
User preference for Curve on Surface (142) entity representation use flag. 0 = Unspecified, use what is defined in the IGES file. 1 = S o B is preferred. (parametric space) 2 = C is preferred. (real space)
Main Index
STRING
group_name[31]
This value specifies the name of the group to which the imported geometry will be added.
LOGICAL
entity_toggle_values(35)
This value specifies the entity type filter status flags to specify which IGES entity types to import.
LOGICAL
color_toggle_values(10)
This value defined the entity color filter status flags to specify which IGES entity colors to import.
STRING
color_method[10]
This value is used to specify the color definition entity method used to import color definition entities.
STRING
color_definition[]
This value specifies the color definition entities to import.
114 PCL Reference Manual File Menu
LOGICAL
all_layers
This value should be set to TRUE if all geometry layers are to be imported.
STRING
layer[]
This value specifies a string that is used to specify the geometry layers to be imported.
INTEGER
number_of_groups
This value is the number of groups defined.
INTEGER
group_entity_ids(number_of_g roups)
This array specifies the ID values for each user group.
LOGICAL
group_entity_values(22, number_of_groups)
This value specifies a two dimensional array that contains values set to TRUE if an entity is to be included and FALSE if an entity is not to be included in the group being imported. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the entity type.
LOGICAL
group_color_values(10, number_of_groups)
This value specifies a two dimensional array that contains values set to TRUE if a color value is to be used. The offset in the first dimension of this array corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of this array identifies the color type.
INTEGER
layer_pointers(number_of_gro ups)
This value specifies an array that is used by setting a value at an offset that corresponds with the offset into the group_entity_ids input value that lists the group ids. The value at that offset in this array identifies the offset into the group_layers input value where the number of layer values for each group is stored. The maximum value allowed for this array is equal to the number of integers in the group_layers input value.
INTEGER
group_layers()
This value specifies an array used to identify the number of layers imported for each group. The size of this array must be equal to or greater than the largest value placed in the layer_pointers input value.
REAL
scale
This value returns the IGES file model space scale.
INTEGER
iges_count(50)
This value returns the number of IGES entities imported by type.
Output:
Main Index
Chapter 2: Basic Functions 115 File Menu
INTEGER
patran_count(9)
INTEGER
This value returns the number of Patran entities written to the database by type. This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: The input value color_method can have a value of “ALL”, “NONE”, or “SPECIFY”. This function will provide information popup forms that list the number of IGES entities imported and Patran entities created. The geometric entities placed in the Patran database will be displayed in the viewport. Example: Please see ugi_import_iges (p. 44) in the PCL Reference Manual Examples.
Main Index
116 PCL Reference Manual File Menu
ugi_import_iges_v5
(file_name, group_name, entity_toggle_values, color_toggle_values, color_method, color_definition, all_layers, layer, number_of_groups, group_entity_ids, group_entity_values, group_color_values, layer_pointers, group_layers, create_groups, groups_prefix, scale, iges_count, patran_count)
Description: This function imports geometry information from a file in the IGES standard file format into the Patran database. Input: STRING
file_name[]
This value specifies the name of the path and the file to be imported.
INTEGER
ipref142
User preference for Curve on Surface (142) entity representation use flag. 0 = Unspecified, use what is defined in the IGES file. 1 = S o B is preferred. (parametric space) 2 = C is preferred. (real space)
Main Index
STRING
group_name[31]
This value specifies the name of the group to which the imported geometry will be added.
LOGICAL
entity_toggle_values(35)
This value specifies the entity type filter status flags to specify which IGES entity types to import.
LOGICAL
color_toggle_values(10)
This value defined the entity color filter status flags to specify which IGES entity colors to import.
STRING
color_method[10]
This value is used to specify the color definition entity method used to import color definition entities.
STRING
color_definition[]
This value specifies the color definition entities to import.
LOGICAL
all_layers
This value should be set to TRUE if all geometry layers are to be imported.
STRING
layer[]
This value specifies a string that is used to specify the geometry layers to be imported.
Chapter 2: Basic Functions 117 File Menu
INTEGER
number_of_groups
This value is the number of groups defined.
INTEGER
group_entity_ids(number_of_g roups)
This array specifies the ID values for each user group.
LOGICAL
group_entity_values(22, number_of_groups)
This value specifies a two dimensional array that contains values set to TRUE if an entity is to be included and FALSE if an entity is not to be included in the group being imported. The offset in the first dimension corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of the array identifies the entity type.
LOGICAL
group_color_values(10, number_of_groups)
This value specifies a two dimensional array that contains values set to TRUE if a color value is to be used. The offset in the first dimension of this array corresponds to the group id in the same offset of the group_entity_ids input value. The offset in the second dimension of this array identifies the color type.
INTEGER
layer_pointers(number_of_gro ups)
This value specifies an array that is used by setting a value at an offset that corresponds with the offset into the group_entity_ids input value that lists the group ids. The value at that offset in this array identifies the offset into the group_layers input value where the number of layer values for each group is stored. The maximum value allowed for this array is equal to the number of integers in the group_layers input value.
INTEGER
group_layers()
This value specifies an array used to identify the number of layers imported for each group. The size of this array must be equal to or greater than the largest value placed in the layer_pointers input value.
LOGICAL
create_groups
This value should be set to TRUE if Patran groups are to be created automatically from IGES layers.
STRING
groups_prefix
This value specifies the group names prefix if Patran groups are to be created automatically from IGES layers. If blank, the group names prefix will be the name of the IGES file imported.
REAL
scale
This value returns the IGES file model space scale.
INTEGER
iges_count(50)
This value returns the number of IGES entities imported by type.
Output:
Main Index
118 PCL Reference Manual File Menu
INTEGER
patran_count(9)
INTEGER
This value returns the number of Patran entities written to the database by type. This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. -1
This is an internal status condition. There is no corresponding status message in the message database.
Remarks: The input value color_method can have a value of “ALL”, “NONE”, or “SPECIFY”. This function will provide information popup forms that list the number of IGES entities imported and Patran entities created. The geometric entities placed in the Patran database will be displayed in the viewport. Example: Please see ugi_import_iges (p. 44) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 119 File Menu
ugi_query_iges_v2
(file_name, query_options, create_report, report_name, entity_count, entity_attributes, num_colors, entity_colors, num_colors_per, num_layers, entity_layers, num_layers_per)
Description: This function provides information on the contents of an IGES geometry file. Input: STRING
file_name[]
This value specifies the name of the path and the file to be imported.
LOGICAL
query_options(7)
This value specifies the types of query operations to perform. See the remarks below for more information.
LOGICAL
create_report
This value specifies, when set to TRUE, that the report information will be written to an Patran report file. When this value is set to FALSE, a report file will not be created.
STRING
report_name[]
This value specifies the name of the Patran report file to which query information is written.
Output:
Main Index
INTEGER
entity_count
This value returns the number of IGES entities identified in the IGES geometry file.
INTEGER
entity_attributes(12,50)
This value returns the IGES entity attributes for each entity type. The use of this array is described in the remarks below.
INTEGER
num_colors(50)
This value returns the number of colors used by the IGES geometry file.
INTEGER
entity_colors(256,50)
This value returns the color numbers per entity type used by the IGES geometry file. See the remarks below for more information on the use of this value.
INTEGER
num_colors_per(256,50)
This value returns the number of colors per entity type used by the IGES geometry file.
INTEGER
num_layers(50)
This value reports the number of layers per entity type in the IGES geometry file.
INTEGER
entity_layers(256,50)
This value returns the layer numbers per entity type in the IGES geometry file.
120 PCL Reference Manual File Menu
INTEGER
num_layers_per(256,50)
This value returns the number of layers per entity type.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: See Status Messages for information on any error values returned by this function. Remarks: This function will provide an information display listing the contents of the IGES file. The input value query_options uses the following offsets to control the type of information placed in a report. When the value at the offset is set to TRUE, the information will be placed in the report. When the value at the offset is set to FALSE, the listed information will be omitted from the report. Offset
Description
1 2 3 4 5 6 7
Report the supported IGES entities. Report the IGES geometric entities. Report a tabulated summary of all IGES entities. Report the visible geometric entities. Report the supported IGES entities with subordinate switches. Report the IGES entity color status. Report the IGES entity level status.
The output value entity_attributes returns the IGES entity attributes for each entity type. Twelve different attributes are counted for 50 entity types. The second dimensional offsets (1-50) of this array are used to list the entity counts for each attribute. The first dimensional offsets in the array are used to identify the entity attributes as follows:
Main Index
Offset
Description
1 2 3 4 5 6 7 8 9 10 11 12
This offset returns the entity type. This offset returns the total number of entities. This offset returns the number of visible entities. This offset returns the number of model space entities. This offset returns the number of parameter space entities. This offset returns the subordinate switch entity value of 0. This offset returns the subordinate switch entity value of 1. This offset returns the subordinate switch entity value of 2. This offset returns the subordinate switch entity value of 3. This offset returns the number of annotation entities. This offset is not used. This offset returns the number of bounded plane entities.
Chapter 2: Basic Functions 121 File Menu
The output value entity_colors returns the color numbers per entity type used by the IGES geometry file. If the color number is negative, its absolute value is an offset into the second dimension of the attributes returned by the output value entity_attributes where a color definition entity is used to define the color. The possible positive color numbers and their colors are: Color Number Color 0 1 2 3 4 5 6 7 8 Example: None
Main Index
No color assigned Black Red Green Blue Yellow Magenta Cyan white
122 PCL Reference Manual File Menu
ge_export_xmt
(filnam, refittol, scale_factor, entity_values, patran_summary, para_summary)
Description: This function will export Patran geometry to a Parasolid transmit file. Input: STRING
filnam[]
This value specifies the Parasolid transmit file name to create.
REAL
refittol
This value specifies the tolerance used to refit Patran geometry to Parasolid format. The default value = geotol/scale_factor, where: geotol = Global Modeling Tolerance scale_factor = Geometry Scale Factor
REAL
scale_factor
This value specifies the Geometry Scale Factor used to convert Patran geometry into Parasolid units. The default value = 39.37
LOGICAL
entity_values(3)
This value specifies the types of Patran geometric entity types to export: (1) = true if curves are to be exported. (2) = true if surfaces are to be exported. (3) = true if solids are to be exported.
Output: INTEGER
patran_summary(3)
This value returns the number of patran geometric entity types exported: (1) = number of curves exported. (2) = number of surfaces exported. (3) = number of solids exported.
INTEGER
para_summary(3)
This value returns the number of parasolid geometric entity types created: (1) = number of parasolid curves created. (2) = number of parasolid surfaces created. (3) = number of parasolid solids created.
Main Index
Chapter 2: Basic Functions 123 File Menu
Error Conditions: See the Status Messages for information on any error values returned by this function. Remarks:
Example:
Main Index
124 PCL Reference Manual Group Menu
Group Menu This section is used to describe functions that are used to create, delete, modify and transform groups of geometric and finite element model entities stored in the database.
ga_group_clear
(group_name)
Description: This function clears a group of all of its members. Input: STRING
group_name[31]
This value specifies the name of the group to clear.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: 11000050
The group name is invalid.
11000105
The specified group was not found in the database.
Remarks: The cleared group and its members remain in the database but the members are no longer associated with the group. The members of the cleared group can still be viewed if they belong to another group which is posted to a viewport. Example: Please see ga_group_clear (p. 47) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 125 Group Menu
ga_group_create_groups
( options, group_name, num_select_1, select_1, num_select_2, select_2 )
Description: Create single or multiple groups using different selection methods. Input: INTEGER
options
Defines the creation options in a bit mask: GA_GROUP_CREATE_SELECTION 0X00000001 GA_GROUP_CREATE_PROP_SETS 0X00000002 GA_GROUP_CREATE_PROP_TYPE 0X00000004 GA_GROUP_CREATE_LBC_SETS 0X00000008 GA_GROUP_CREATE_LBC_TYPE 0X00000010 GA_GROUP_CREATE_MATERIAL 0X00000020 GA_GROUP_CREATE_ELM_TOPS 0X00000040 GA_GROUP_CREATE_ELM_SHAPE 0X00000080 GA_GROUP_CREATE_ELEM_IDS 0X00000100 GA_GROUP_CREATE_MPC_TYPE 0X00000200 GA_GROUP_CREATE_BOOLEAN 0X00000400
STRING
group_name [32]
Group name.
INTEGER
num_select_1
The starting element id for an option value of GA_GROUP_CREATE_ELEM_IDS
STRING
select_1 [32] ()
The first selected list of entities.
INTEGER
num_select_2
The ending element id for an option value of GA_GROUP_CREATE_ELEM_IDS
STRING
select_2 [32] ()
The second selected list of entities.
0 if no error have occured.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000049
A group with the given name is already in the database.
11000050
The group name is invalid.
11000097
There is not enough disk space to complete operation.
11000098
A fatal error has occurred in the database. Database is corrupted.
Remarks: The group created through the use of this function must be posted to a viewport before any added entities can be viewed.
Main Index
126 PCL Reference Manual Group Menu
Example: None
ga_group_current_set
(group_name)
Description: This function will set any new entities as members of the specified group and then post the specified group to the current viewport. Input: STRING
group_name[31]
This value specifies the name of the group to which new entities will be set and that will be posted to the current viewport,
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000049
A group with the given name is already in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Remarks: None Example: Please see ga_group_current_set (p. 48) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 127 Group Menu
ga_group_delete
(group_name)
Description: This function will delete a group from the database. Input: STRING
group_name[31]
This value specifies the name of the group. Setting this string to nothing or “” will allow the use of the current group to be deleted.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000050
The group name is invalid.
11000121
There is not a current group defined.
11000140
The group can not be deleted while selected as the current group of any viewport.
11000105
The specified group was not found in the database.
Remarks: Any disassociated members of the deleted group remain in the database. They can only be viewed if they are members of or added as members to another group which is posted to a viewport. Example: Please see ga_group_delete (p. 49) in the PCL Reference Manual Examples.
Main Index
128 PCL Reference Manual Group Menu
ga_group_display_set
(group_name, display_list)
Description: This function changes the current display property list associated with a group and posts the group to the current viewport. Input: STRING
group_name[31]
This value specifies the name of the group. Setting this string to nothing or “” will allow the use of the current group.
STRING
display_list[31]
This value is the name of the display property list.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000118
There is no display property posted to the group.
11000121
There is not a current group defined.
Remarks: None Example: Please see ga_group_display_set (p. 50) in the PCL Reference Manual Examples.
ga_group_entity_add
(group_name, entities)
Description: This function adds a list of entities as members to a group. Input: STRING
Main Index
group_name[31]
This value specifies the name of the group to which the entities will be added. Setting this string to nothing or “” will allow the use of the current group.
Chapter 2: Basic Functions 129 Group Menu
STRING
entities[]
This value specifies the list of entities to be added to the group.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 1000025
Error attempting to allocate virtual memory.
11000011
The entity is not contained in the specified group.
11000012
The entity is already contained in the specified group.
11000050
The group name is invalid.
11000078
The specified entity could not be found in the database
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
Remarks: Entities can be added as members to any number of groups. Example: Please see ga_group_entity_add (p. 51) in the PCL Reference Manual Examples.
Main Index
130 PCL Reference Manual Group Menu
ga_group_entity_remove
(group_name, entities)
Description: This function will remove a list of entities from a group. Input: STRING
group_name[31]
This value specifies the name of the group. Setting this string to nothing or “” will allow the use of the current group.
STRING
entities[]
This value specifies the list of entities to be disassociated from the group.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000050
The group name is invalid.
11000121
There is not a current group defined.
11000011
The entity is not contained in the specified group.
Remarks: This function will not remove an entity from the database but will remove its association with the specified group. Removed entities that are members of another group can be posted to and redisplayed in the viewport by pressing the repaint icon on the right end of the menu bar. Example: Please see ga_group_entity_remove (p. 53) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 131 Group Menu
ga_group_members_delete
(group_name)
Description: This function will delete all of the entities from a group. Input: STRING
group_name[31]
This value specifies the name of the group. Setting this string to nothing or “” will allow the use of the current group.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
Remarks: This function will delete all of the entities associated with the specified group even if they are members of other groups as well. This function will delete all entities associated with the specified group except for any nodes that are associated with an element or MPC which is not a member of the targeted group. Example: Please see ga_group_members_delete (p. 54) in the PCL Reference Manual Examples.
Main Index
132 PCL Reference Manual Group Menu
ga_group_move_translate
(ngroups, group_names, coordinate_frame_id, translation_vector, action_flag)
Description: This function moves a group of model geometry and FEM entities from one place in the model space to another. Input: INTEGER
ngroups
This value specifies the number of groups to copy.
STRING
group_names[]
This value specifies the names of the groups that will have their positions translated. Set this string to “” to transform the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
translation_vector[]
This value specifies the group translation direction and distance.
INTEGER
action_flag
This value specifies whether or not to transform Loads/Boundary Conditions and Properties: 8=transform Loads/Boundary Conditions 16=transform Properties 24=transform both Loads/Boundary Conditions and Properties
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
Chapter 2: Basic Functions 133 Group Menu
14000295
LpSublistAttributeGet: The CAD native curve cannot be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface cannot be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display the following messages in a popup form:
Main Index
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
134 PCL Reference Manual Group Menu
ga_group_move_translate_1
(ngroups, group_names, coordinate_frame_id, translation_vector, vector_magnitude, reverse_dir, action_flag)
Description: This function moves a group of model geometry and FEM entities to a different space within the model. Input: INTEGER
ngroups
This value specifies the number of groups to copy.
STRING
group_names[]
This value specifies the names of the groups that will have their positions translated. Set this string to “” to transform the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
translation_vector[]
This value specifies the group translation direction.
REAL
vector_magnitude
This value specifies the group translation distance.
LOGICAL
reverse_dir
This value specifies whether or not to reverse the direction vector.
INTEGER
action_flag
This value specifies whether or not to transform Loads/Boundary Conditions and Properties: 8=transform Loads/Boundary Conditions 16=transform Properties 24=transform both Loads/Boundary Conditions and Properties
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
Chapter 2: Basic Functions 135 Group Menu
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve cannot be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface cannot be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: This function can display the following messages in a popup form:
Main Index
136 PCL Reference Manual Group Menu
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
ga_group_precision_set
(group_name, precision_status)
Description: This function sets the precision of the rendering for a specified group. Input: STRING
group_name[]
This value specifies the name of the group. Set this string to nothing or “” to use of the current group.
INTEGER
precision_status
This is the value to be used as the precision for the group which can have the following values: 0 for speed, 1 for accuracy.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
Chapter 2: Basic Functions 137 Group Menu
Remarks: See the listing for this function in Broken, Obsolete, Modified and New Functions for further information. Example: Please see ga_group_precision_set (p. 55) in the PCL Reference Manual Examples.
ga_group_rename
(original_name, new_name)
Description: This function renames a group. Input: STRING
original_name[31]
This value specifies the original name of the group. Setting this string to nothing or “” will allow the use of the current group.
STRING
new_name[31]
This value specifies the new name of the group.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
Remarks: None. Example: Please see ga_group_rename (p. 56) in the PCL Reference Manual Examples.
Main Index
138 PCL Reference Manual Group Menu
ga_group_transform_mirror
(group_name, plane, offset, delete_original, use_original_labels, reverse)
Description: This function creates a new set of entities which are a mirror of the entities contained in the named group. Input: STRING
group_name[31]
This value specifies the name of the group to be mirrored. This value can be set to “” to mirror the current group.
STRING
plane[]
This value specifies the plane around which the mirror transformation will take place.
REAL
offset
This value specifies a distance along a vector that is normal to the mirror plane, starting at the mirror plane surface. This distance defines an offset for the placement of the mirrored entities.
LOGICAL
delete_original
This value, when set to TRUE, specifies the deletion of the original geometry being mirrored.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the mirrored entities to be used.
LOGICAL
reverse
This value, when set to TRUE, will allow the parametric direction of the curves and surfaces of the mirrored geometry to be reversed.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
1000054
An invalid geometric entity type was used as input. The valid entity type to use is%A%. Unable to process request.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
Chapter 2: Basic Functions 139 Group Menu
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: This function is implemented through a call to the function ga_group_transform_mirror2(). The call to the function ga_group_transform_mirror2() is done with the lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to “”. The new entities created will become members of the current group of the current viewport. Load boundary conditions (LBC) and element property sets assigned to the named group are not mirrored to the new entities. To mirror the load boundary conditions and element property sets, use the function ga_group_transform_mirror2(). See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a warning popup form with the following messages:
Main Index
1000054
An invalid geometric entity type was used as input. The valid entity type to use is%A%. Unable to process request.
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
140 PCL Reference Manual Group Menu
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
This function can display a fatal popup form with the following messages: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Example: Please see ga_group_transform_mirror (p. 57) in the PCL Reference Manual Examples
ga_group_transform_mirror2
(group_name, plane, offset, delete_original, use_original_labels, reverse, lbc_copy_sets, lbc_transform_sets, prop_copy_sets, prop_transform_sets)
Description: This function creates a set of entities which are a mirror of the entities contained in the named group. Input:
Main Index
Chapter 2: Basic Functions 141 Group Menu
STRING
group_name[31]
This value specifies the name of the group to be mirrored. This value can be set to “” to mirror the current group.
STRING
plane[]
This value specifies the plane around which the mirror transformation will take place.
REAL
offset
This value specifies a distance along a vector that is normal to the mirror plane, starting at the mirror plane surface. This distance defines an offset for the placement of the mirrored entities.
LOGICAL
delete_original
This value, when set to TRUE, will allow the deletion of the original geometry being mirrored.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the mirrored entities to be used.
LOGICAL
reverse
This value, when set to TRUE, will allow the parametric direction of the curves and surfaces of the mirrored geometry to be reversed.
STRING
lbc_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be copied, with no coordinate transformations, to the mirrored entities.
STRING
lbc_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be mirrored to the mirrored entities.
STRING
prop_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be copied, with no coordinate transformations, to the mirrored entities.
STRING
prop_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be mirrored to the mirrored entities.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 1000054
Main Index
An invalid geometric entity type was used as input. The valid entity type to use is%A%. Unable to process request.
142 PCL Reference Manual Group Menu
Main Index
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Chapter 2: Basic Functions 143 Group Menu
Remarks: If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets input values, the load boundary conditions will be copied and not transformed. If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the property set will be copied and not transformed. If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets are not used they should be set up as an array of one string set to “”. The new entities created will become members of the current group of the current viewport. See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a warning popup form with the following messages:
Main Index
1000054
An invalid geometric entity type was used as input. The valid entity type to use is%A%. Unable to process request.
14000003
LpSublistType: No sublist filter bits are set on invocation
14000004
LpSublistType: I am being invoked with a NULL list
14000005
LpSublistType: In the list being used, the current sublist has a nonatomic CAR.
14000006
LpSublistType: In the list being used, the current geometry sublist is unclassifiable.
14000007
LpSublistType: In the list being used, the current finite element sublist is unclassifiable.
14000008
LpSublistType: In the list being used, the current token sublist is unclassifiable.
14000009
LpSublistType: In the list being used, the current sublist is unclassifiable.
14000010
LpSublistType: In the list being used, the current sublist does not match the sublist filter.
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
144 PCL Reference Manual Group Menu
This function can display a fatal popup form with the following messages: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Example: Please see ga_group_transform_mirror2 (p. 58) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 145 Group Menu
ga_group_transform_pivot
(group_name, pivot_point, start_point, end_point, delete_original, use_original_labels)
Description: This function creates a set of entities which are a copy of the entities contained in the named group, pivoted around a point defined in space. Input: STRING
group_name[31]
This value specifies the name of the group to be pivoted. This value can be set to “” to pivot the current group.
STRING
pivot_point[]
This value specifies the point around which the model and FEM geometry will be pivoted.
STRING
start_point[]
This value specifies the starting point from which the pivot operation will take place.
STRING
end_point[]
This value specifies the ending point from which the pivot operation will take place.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being pivoted to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
1
This is an internal status condition. There is no corresponding status message in the message database.
2
This is an internal status condition. There is no corresponding status message in the message database.
3
This is an internal status condition. There is no corresponding status message in the message database.
1000211
The length of the Axis equals zero.
1000302
The three points specified are nearly collinear.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
146 PCL Reference Manual Group Menu
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: This function is implemented through a call to the function ga_group_transform_pivot2(). The call to the function ga_group_transform_pivot2() is done with the lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to “”. The new entities created will become members of the current group of the current viewport. Load boundary conditions (LBC) and element property sets assigned to the named group are not added to the new entities. To add the load boundary conditions and element property sets, use the function ga_group_transform_pivot2(). See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function can display a popup forms with the following messages:
Main Index
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000208
LpSublistAttributeGet: Curve evaluator error
Chapter 2: Basic Functions 147 Group Menu
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
Example: Please see ga_group_transform_pivot (p. 60) in the PCL Reference Manual Examples.
ga_group_transform_pivot2
(group_name, pivot_point, start_point, end_point, delete_original, use_original_labels, lbc_copy_sets, lbc_transform_sets, prop_copy_sets, prop_transform_sets)
Description: This function creates a set of entities which are a copy of the entities contained in the named group, pivoted around a point defined in space. Input:
Main Index
STRING
group_name[31]
This value specifies the name of the group to be pivoted. This value can be set to “” to pivot the current group.
STRING
pivot_point[]
This value specifies the point around which the model and FEM geometry will be pivoted.
STRING
start_point[]
This value specifies the starting point from which the pivot operation will take place.
STRING
end_point[]
This value specifies the ending point from which the pivot operation will take place.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being pivoted to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
STRING
lbc_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be copied, with no coordinate transformations, to the copied entities.
148 PCL Reference Manual Group Menu
STRING
lbc_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be added to the transformed entities.
STRING
prop_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be copied, with no coordinate transformations, to the transformed entities.
STRING
prop_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be added to the transformed entities.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
1
This is an internal status condition. There is no corresponding status message in the message database.
2
This is an internal status condition. There is no corresponding status message in the message database.
3
This is an internal status condition. There is no corresponding status message in the message database.
1000211
The length of the Axis equals zero.
1000302
The three points specified are nearly collinear.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
Chapter 2: Basic Functions 149 Group Menu
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets input values, the load boundary conditions will be copied and not transformed. If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the property set will be copied and not transformed. If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets are not used they should be set up as an array of one string set to “”. The new entities created will become members of the current group of the current viewport. See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function can display popup forms with the following messages: 14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
Example: Please see ga_group_transform_pivot2 (p. 61) in the PCL Reference Manual Examples.
Main Index
150 PCL Reference Manual Group Menu
ga_group_transform_position
(group_name, start_point_1, start_point_2, start_point_3, end_point_1, end_point_2, end_point_3, delete_original, use_original_labels)
Description: This function will do a rigid body positional and rotational translation of a group of model geometry and FEM entities. Input: STRING
group_name[31]
This value specifies the name of the group that will have its position transformed. This value can be set to “” to transform the current group.
STRING
start_point_1[]
This value specifies the first point in space used to define a coordinate system for the starting position of the position translation operation.
STRING
start_point_2[]
This value silicifies the second point in space used to define a coordinate system for the starting position of the position translation operation.
STRING
start_point_3[]
This value specifies the third point in space used to define a coordinate system for the starting position of the position translation operation.
STRING
end_point_1[]
This value specifies the first point in space used to define a coordinate system for the ending position of the position translation operation.
STRING
end_point_2[]
This value specifies the second point in space used to define a coordinate system for the ending position of the position translation operation.
STRING
end_point_3[]
This value specifies the third point in space used to define a coordinate system for the ending position of the position translation operation.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being transformed to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Main Index
Chapter 2: Basic Functions 151 Group Menu
Error Conditions: This is only a partial list of the error values that can be returned by this function. 1000211
The length of the Axis equals zero.
1000302
The three points specified are nearly collinear.
13000088
Preference not found
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: Both the starting_point and the ending_point three point sets of input values define a temporary coordinate frame. The positional and angular differences between the two frames establish the translation vector and planar rotation angles which are used to transform the named group. The vector extending from the input values starting_point_1 to ending_point_1 define the positional translation component of this operation. The angular relationship between the pair of vectors defined by starting_point_1 and starting_point_2, and the vectors ending_point_1 and ending_point2 and the angular relationship between the pair of vectors defined by starting_point_1 and starting_point_3, and the vectors ending_point_1 and ending_point3 define the planar translation angles for the positional translation operation. This function is implemented through a call to the function ga_group_transform_position2(). The call to the function ga_group_transform_position2() is done with the lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to “”. The new entities created will become members of the current group of the current viewport.
Main Index
152 PCL Reference Manual Group Menu
Load boundary conditions (LBC) and element property sets assigned to the named group are not added to the new entities. To add the load boundary conditions and element property sets, use the function ga_group_transform_position2(). See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Example: Please see ga_group_transform_position (p. 63) in the PCL Reference Manual Examples.
ga_group_transform_position2
(group_name, start_point_1, start_point_2, start_point_3, end_point_1, end_point_2, end_point_3, delete_original, use_original_labels, lbc_copy_sets, lbc_transform_sets, prop_copy_sets, prop_transform_sets)
Description: This function will do a rigid body positional and rotational translation of a group of model geometry and FEM entities. Input:
Main Index
STRING
group_name[31]
This value specifies the name of the group that will have its position transformed. This value can be set to “” to transform the current group.
STRING
start_point_1[]
This value specifies the first point in space used to define a coordinate system for the starting position of the position translation operation.
STRING
start_point_2[]
This value specifies the second point in space used to define a coordinate system for the starting position of the position translation operation.
STRING
start_point_3[]
This value specifies the third point in space used to define a coordinate system for the starting position of the position translation operation.
Chapter 2: Basic Functions 153 Group Menu
STRING
end_point_1[]
This value specifies the first point in space used to define a coordinate system for the ending position of the position translation operation.
STRING
end_point_2[]
This value specifies the second point in space used to define a coordinate system for the ending position of the position translation operation.
STRING
end_point_3[]
This value specifies the third point in space used to define a coordinate system for the ending position of the position translation operation.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being transformed to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
STRING
lbc_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be copied, with no coordinate transformations, to the copied entities.
STRING
lbc_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be added to the transformed entities.
STRING
prop_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be copied, with no coordinate transformations, to the transformed entities.
STRING
prop_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be added to the transformed entities.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
1000211
The length of the Axis equals zero.
1000302
The three points specified are nearly collinear.
13000088
Preference not found
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
154 PCL Reference Manual Group Menu
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets input values, the load boundary conditions will be copied and not transformed. If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the property set will be copied and not transformed. If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets are not used they should be set up as an array of one string set to “”. The new entities created will become members of the current group of the current viewport. See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Example: Please see ga_group_transform_position2 (p. 65) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 155 Group Menu
ga_group_transform_rotate
(group_name, coordinate_frame_id, rotation_axis, rotational_angle, offset_angle, delete_original, use_original_labels, repeat_count)
Description: This function will do a rigid body rotational translation of a group of model geometry and FEM entities. Input: STRING
group_name[31]
This value specifies the name of the group that will have its position rotated. This value can be set to “” to rotate the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
rotation_axis[]
This value specifies a vector that is normal to the plane of rotation. This vector forms the axis around which the rotation translation will take place.
REAL
rotation_angle[]
This value specifies the angle of displacement in degrees that will take place around the axis of rotation.
REAL
offset_angle[]
This value specifies an angular offset in degrees around the axis of rotation for the start of the rotational translation.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being transformed to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
INTEGER
repeat_count
This value specifies the number of times to repeat the transform with each additional transform being positioned relative to the previous transformation results.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
1
This is an internal status condition. There is no corresponding status message in the message database.
2011004
The Repeat Count must be greater than 0.
156 PCL Reference Manual Group Menu
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: This function is implemented through a call to the function ga_group_transform_rotate2(). The call to the function ga_group_transform_rotate2() is done with the lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to “”. The new entities created will become members of the current group of the current viewport. Load boundary conditions (LBC) and element property sets assigned to the named group are not added to the new entities. To add the load boundary conditions and element property sets, use the function ga_group_transform_rotate2(). See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: This function can display the following messages in a popup form: Example: Please see ga_group_transform_rotate (p. 67) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 157 Group Menu
ga_group_transform_rotate2
(group_name, coordinate_frame_id, rotation_axis, rotational_angle, offset_angle, delete_original, use_original_labels, repeat_count, lbc_copy_sets, lbc_transform_sets, prop_copy_sets, prop_transform_sets)
Description: This function will do a rigid body rotational translation of a group of model geometry and FEM entities. Input:
Main Index
STRING
group_name[31]
This value specifies the name of the group that will have be rotated. This value can be set to “” to rotate the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
rotation_axis[]
This value specifies a vector that is normal to the plane of rotation. This vector forms the axis around which the rotation translation will take place.
REAL
rotation_angle[]
This value specifies the angle of displacement in degrees that will take place around the axis of rotation.
REAL
offset_angle[]
This value specifies an angular offset in degrees around the axis of rotation for the start of the rotational translation.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being transformed to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
INTEGER
repeat_count
This value specifies the number of times to repeat the transform with each additional transform being positioned relative to the previous transformation results.
STRING
lbc_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be copied, with no coordinate transformations, to the copied entities.
STRING
lbc_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be added to the transformed entities.
158 PCL Reference Manual Group Menu
STRING
prop_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be copied, with no coordinate transformations, to the transformed entities.
STRING
prop_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be added to the transformed entities.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 1
This is an internal status condition. There is no corresponding status message in the message database.
2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets input values, the load boundary conditions will be copied and not transformed.
Main Index
Chapter 2: Basic Functions 159 Group Menu
If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the property set will be copied and not transformed. If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets are not used they should be set up as an array of one string set to “”. The new entities created will become members of the current group of the current viewport. See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function can display the following messages in a popup form: 14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
Example: Please see ga_group_transform_rotate2 (p. 68) in the PCL Reference Manual Examples.
Main Index
160 PCL Reference Manual Group Menu
ga_group_transform_scale
(group_name, coordinate_frame_id, origin_point, scale_factors, delete_original, use_original_labels, repeat_count)
Description: This function will change the scale of the selected group of model geometry and FEM entities. Input: STRING
group_name[31]
This value specifies the name of the group that will have its position scaled. This value can be set to “” to scale the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
origin_point[]
This value specifies a point in space from which the group will be scaled.
REAL
scale_factors[3]
This value specifies the scale factors in the X, Y, and Z coordinate axis.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being transformed to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
INTEGER
repeat_count
This value specifies the number of times to repeat the transform with each additional transform being positioned relative to the previous transformation results.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
Chapter 2: Basic Functions 161 Group Menu
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: This function is implemented through a call to the function ga_group_transform_scale2(). The call to the function ga_group_transform_scale2() is done with the lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets input valueinput values all set to “”. The new entities created will become members of the current group of the current viewport. Load boundary conditions (LBC) and element property sets assigned to the named group are not added to the new entities. To add the load boundary conditions and element property sets, use the function ga_group_transform_scale2(). See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function can display the following messages in a popup form:
Main Index
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
162 PCL Reference Manual Group Menu
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
See the listing for this function in Broken, Obsolete, Modified and New Functions for further information. Example: Please see ga_group_transform_scale (p. 71) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 163 Group Menu
ga_group_transform_scale2
(group_name, coordinate_frame_id, origin_point,scale_factors, delete_original, use_original_labels, repeat_count, lbc_copy_sets, lbc_transform_sets, prop_copy_sets, prop_transform_sets)
Description: This function will change the scale of the selected group of model geometry and FEM entities. Input:
Main Index
STRING
group_name[31]
This value specifies the name of the group that will have its position scaled. This value can be set to “” to scale the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
origin_point[]
This value specifies a point in space from which the group will be scaled.
REAL
scale_factors[3]
This value specifies the scale factors in the X, Y, and Z coordinate axis.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being transformed to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
INTEGER
repeat_count
This value specifies the number of times to repeat the transform with each additional transform being positioned relative to the previous transformation results.
STRING
lbc_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be copied, with no coordinate transformations, to the copied entities.
STRING
lbc_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be added to the transformed entities.
STRING
prop_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be copied, with no coordinate transformations, to the transformed entities.
164 PCL Reference Manual Group Menu
STRING
prop_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be added to the transformed entities.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets input values, the load boundary conditions will be copied and not transformed. If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the property set will be copied and not transformed. If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets are not used they should be set up as an array of one string set to “”. The new entities created will become members of the current group of the current viewport. See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages:
Main Index
Chapter 2: Basic Functions 165 Group Menu
This function can display the following messages in a popup form: See the listing for this function in Broken, Obsolete, Modified and New Functions for further information. Example: Please see ga_group_transform_scale2 (p. 73) in the PCL Reference Manual Examples.
ga_group_transform_translate
(group_name, coordinate_frame_id, translation_vector, delete_original, use_original_labels, repeat_count)
Description: This function will move or translate a group of model geometry and FEM entities from one place in the model space to another. Input: STRING
group_name[31]
This value specifies the name of the group that will have its position translated. This value can be set to “” to transform the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
translation_vector[]
This value specifies the direction and distance that the group will be translated.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being transformed to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
INTEGER
repeat_count
This value specifies the number of times to repeat the transform with each additional transform being positioned relative to the previous transformation results.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
166 PCL Reference Manual Group Menu
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: This function is implemented through a call to the function ga_group_transform_translate2(). The call to the function ga_group_transform_translate2() is done with the lbc_copy_sets, lbc_transform_sets, prop_copy_sets, and prop_transform_sets input values all set to “”. The new entities created will become members of the current group of the current viewport. Load boundary conditions (LBC) and element property sets assigned to the named group are not added to the new entities. To add the load boundary conditions and element property sets, use the function ga_group_transform_translate2(). See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000281
LpExpandPclVariables: Virtual memory is full.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
This function can display the following messages in a popup form:
Main Index
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
Chapter 2: Basic Functions 167 Group Menu
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
Example: Please see ga_group_transform_translate (p. 75) in the PCL Reference Manual Examples.
ga_group_transform_translate_1
(ngroups, group_names, coordinate_frame_id, translation_vector, action_flag, name_flag, new_group_names, repeat_count)
Description: This function will copy a group of model geometry and FEM entities from one place in the model space to another. Input: INTEGER
ngroups
This value specifies the number of groups to copy.
STRING
group_names[]
This value specifies the names of the groups that will have their positions translated. This value can be set to “” to transform the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
translation_vector[]
This value specifies the group translation direction and distance.
INTEGER
action_flag
This value specifies whether or not to transform Loads/Boundary Conditions and Properties: 8=transform Loads/Boundary Conditions 16=transform Properties 24=transform both Loads/Boundary Conditions and Properties
Main Index
168 PCL Reference Manual Group Menu
INTEGER
name_flag
This value specifies how to interpret the “new_group_names” argument describing the “Transformed Group Name(s)”: 0=Original Group Name 1=New Group Name 2=Group Name Prefix 3=Group Name Suffix 4=Current Group Name
STRING
new_group_names
This value specifies the string associated with the argument “name_flag”. This will be either a: New Group Name Group Name Prefix, or Group Name Suffix
INTEGER
repeat_count
This value specifies the number of times to repeat the transform with each additional transform being positioned relative to the previous transformation results.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
Chapter 2: Basic Functions 169 Group Menu
14000295
LpSublistAttributeGet: The CAD native curve cannot be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface cannot be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 2011004
The Repeat Count must be greater than 0.
This function can display the following messages in a popup form:
Main Index
170 PCL Reference Manual Group Menu
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
ga_group_transform_translate2
(group_name, coordinate_frame_id, translation_vector, delete_original, use_original_labels, repeat_count, lbc_copy_sets, lbc_transform_sets, prop_copy_sets, prop_transform_sets)
Description: This function will move or translate a group of model geometry and FEM entities from one place in the model space to another. Input:
Main Index
STRING
group_name[31]
This value specifies the name of the group that will have its position translated. This value can be set to “” to transform the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
translation_vector[]
This value specifies the direction and distance that the group will be translated.
LOGICAL
delete_original
This value, when set to TRUE, will cause the original geometry being transformed to be deleted.
LOGICAL
use_original_labels
This value, when set to TRUE with the input value delete_original being set to TRUE, will allow the original geometry IDs for the pivoted entities to be used.
Chapter 2: Basic Functions 171 Group Menu
INTEGER
repeat_count
This value specifies the number of times to repeat the transform with each additional transform being positioned relative to the previous transformation results.
STRING
lbc_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be copied, with no coordinate transformations, to the copied entities.
STRING
lbc_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the load boundary condition sets to be added to the transformed entities.
STRING
prop_copy_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be copied, with no coordinate transformations, to the transformed entities.
STRING
prop_transform_sets[]()
This value specifies an array of strings, terminated by an empty string, listing the names of the property sets to be added to the transformed entities.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
172 PCL Reference Manual Group Menu
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: If a load boundary condition (LBC) is a member of both the lbc_copy_sets and the lbc_transform_sets input values, the load boundary conditions will be copied and not transformed. If a property set is a member of both the prop_copy_sets and the prop_transform_sets input values, the property set will be copied and not transformed. If the any of the input values lbc_copy_sets, lbc_transform_sets, prop_copy_sets, prop_transform_sets are not used they should be set up as an array of one string set to “”. The new entities created will become members of the current group of the current viewport. See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 2011004
The Repeat Count must be greater than 0.
This function can display the following messages in a popup form:
Main Index
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve cannot be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface cannot be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Chapter 2: Basic Functions 173 Group Menu
Example: Please see ga_group_transform_translate2 (p. 77) in the PCL Reference Manual Examples
Main Index
174 PCL Reference Manual Group Menu
ga_group_transform_translate_2
(ngroups, group_names, coordinate_frame_id, translation_vector, vector_magnitude, reverse_dir, action_flag, name_flag, new_group_names, repeat_count)
Description: This function will copy a group of model geometry and FEM entities from one place in the model space to another. Input: INTEGER
Ngroups
This value specifies the number of groups to copy.
STRING
group_names[]
This value specifies the names of the groups that will have their positions translated. This value can be set to “” to transform the current group.
STRING
coordinate_frame_id[]
This value specifies the reference coordinate frame.
STRING
translation_vector[]
This value specifies the direction that the group will be translated.
REAL
vector_magnitude
This value specifies the distance that the group will be translated.
LOGICAL
reverse_dir
This value specifies whether or not to reverse the direction vector.
INTEGER
action_flag
This value specifies whether or not to transform Loads/Boundary Conditions and Properties: 8=transform Loads/Boundary Conditions 16=transform Properties 24=transform both Loads/Boundary Conditions and Properties
INTEGER
name_flag
This value specifies how to interpret the “new_group_names” argument describing the “Transformed Group Name(s)”: 0=Original Group Name 1=New Group Name 2=Group Name Prefix 3=Group Name Suffix 4=Current Group Name
Main Index
Chapter 2: Basic Functions 175 Group Menu
STRING
new_group_names
This value specifies the string associated with the argument “name_flag”. This will be either a: New Group Name Group Name Prefix, or Group name Suffix
INTEGER
repeat_count
This value specifies the number of times to repeat the transform with each additional transform being positioned relative to the previous transformation results.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 2011004
The Repeat Count must be greater than 0.
14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
Remarks: See All About Groups (Ch. 5) in the Patran Reference Manual for more information. This function can display a fatal popup form with the following messages: 2011004
Main Index
The Repeat Count must be greater than 0.
176 PCL Reference Manual Group Menu
This function can display the following messages in a popup form: 14000001
LpGetHeapSpace: Allocated heap space is exhausted
14000012
LpSublistAttributeGet: Attribute to retrieve is undefined
14000013
LpSublistAttributeGet: Attribute to retrieve is not found in the current sublist
14000049
LpParseExpression: Excess left parenthesis detected.
14000050
LpParseExpression: Excess right parenthesis detected.
14000208
LpSublistAttributeGet: Curve evaluator error
14000210
LpSublistAttributeGet: Insufficient size in return area for geometry
14000211
LpSublistAttributeGet: Surface evaluator error
14000281
LpExpandPclVariables: Virtual memory is full.
14000295
LpSublistAttributeGet: The CAD native curve can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000296
LpSublistAttributeGet: The CAD native surface can not be accurately approximated to within an order of magnitude of the present geometric tolerance.
14000308
LpEval: Memory exhausted preparing to evaluate pick.
.
uil_group_members_get
(group_name, members)
Description: This function will get a list of all the members of a group. Input: STRING
group_name[31]
This value specifies the name of the group that will be retrieved. This value can be set to “” to retrieve the current group.
STRING
members[VIRTUAL]
This value returns a list of the members of the group.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function.
Main Index
8104003
Out of room in destination format string.
8107002
Last command aborted.
11000050
The group name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
Chapter 2: Basic Functions 177 Group Menu
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000127
The group does not have any entities in it.
Remarks: Space is internally allocated for the output value members. It is the responsibility of the calling function to free the allocated string storage space. Example: Please see uil_group_members_get (p. 78) in the PCL Reference Manual Examples.
Main Index
178 PCL Reference Manual Viewing Menu
Viewing Menu This section is used to describe functions that are used to create, delete, modify and retrieve the settings of named views stored in the database.
ga_view_aa_get
(name_of_view, angle_x, angle_y, angle_z)
Description: This function gets the absolute x, y, and z angles of rotation around the axes of the global model coordinate system of the specified view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the absolute angles will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
angle_x
This value returns the rotation about the x axis.
REAL
angle_y
This value returns the rotation about the y axis.
REAL
angle_z
This value returns the rotation about the z axis.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_aa_get (p. 127) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 179 Viewing Menu
ga_view_aa_set
(angle_x, angle_y, angle_z)
Description: This function sets the absolute x, y, and z angles of rotation around the axes of the global model coordinate system for the current view. Input: REAL
angle_x
This value specifies the angle of rotation for the x axis.
REAL
angle_y
This value specifies the angle of rotation for the y axis.
REAL
angle_z
This value specifies the angle of rotation for the z axis.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000014
Viewport not found
Remarks: None Example: Please see ga_view_aa_set (p. 128) in the PCL Reference Manual Examples.
Main Index
180 PCL Reference Manual Viewing Menu
ga_view_ar_set
(angle_x, angle_y, angle_z)
Description: This function sets the x, y, and z angles of rotation around the axes of the global model coordinate system for the current view relative to current rotational position. Input: REAL
angle_x
This value specifies the angle of rotation for the x axis.
REAL
angle_y
This value specifies the angle of rotation for the y axis.
REAL
angle_z
This value specifies the angle of rotation for the z axis.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000014
Viewport not found
Remarks: None. Example: Please see ga_view_ar_set (p. 129) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 181 Viewing Menu
ga_view_back_get
(name_of_view, distance)
Description: This function gets the distance of the back clipping plane. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the back clipping plane will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
distance
This value returns the location of back clipping plane.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000014
Viewport not found
Remarks: The back clipping plane distance is the distance from the origin of global model coordinate frame to the back clipping plane along the z axis. This distance must be less than the distance of the front clipping plane. Example: Please see ga_view_back_get (p. 130) in the PCL Reference Manual Examples.
ga_view_back_set
(distance)
Description: This function sets the distance of the back clipping plane. Input:
Main Index
182 PCL Reference Manual Viewing Menu
REAL
distance
This value sets the location of back clipping plane.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: The back clipping plane distance is the distance from the origin of global model coordinate frame to the back clipping plane along the z axis. This distance must be less than the distance of the front clipping plane. Example: Please see ga_view_back_set (p. 132) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 183 Viewing Menu
ga_view_capping_get
(name_of_view, capping_status)
Description: This function will return the on/off status for capping. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the capping status will be obtained. If this value is set to nothing or ““, the current view will be used.
LOGICAL
capping_status
This value returns the on/off status of capping. It will be set TRUE for on, FALSE for off.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_capping_get (p. 133) in the PCL Reference Manual Examples.
Main Index
184 PCL Reference Manual Viewing Menu
ga_view_capping_set
(capping_status)
Description: This function sets the on/off status of capping for the current view. Input: LOGICAL
capping_status
This value sets the status of capping to either TRUE for on, or FALSE for off.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_capping_set (p. 134) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 185 Viewing Menu
ga_view_center_get
(name_of_view, coordinate_x, coordinate_y)
Description: This function returns the location of the center of the named view in the global model coordinate system. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the center location will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
coordinate_x
This value returns the x coordinate for the center of the view.
REAL
coordinate_y
This value returns the y coordinate for the center of the view.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_center_get (p. 135) in the PCL Reference Manual Examples.
Main Index
186 PCL Reference Manual Viewing Menu
ga_view_center_set
(coordinate_x, coordinate_y)
Description: This function centers the current view around a specified point in the global model coordinate system. Input: REAL
coordinate_x
This value specifies the x coordinate around which the view will be centered.
REAL
coordinate_y
This value specifies the x coordinate around which the view will be centered.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_center_set (p. 137) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 187 Viewing Menu
ga_view_clipping_get
(name_of_view, clipping_status)
Description: This function will return the on/off status for clipping. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the clipping status will be obtained. If this value is set to nothing or ““, the current view will be used.
LOGICAL
clipping_status
This value returns the on/off status of capping. It will be set TRUE for on, FALSE for off.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_clipping_get (p. 138) in the PCL Reference Manual Examples.
Main Index
188 PCL Reference Manual Viewing Menu
ga_view_clipping_set
(clipping_status)
Description: This function sets the on/off status of clipping for the current view. Input: LOGICAL
clipping_status
This value sets the status of clipping to either TRUE for on, or FALSE for off.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_clipping_set (p. 139) in the PCL Reference Manual Examples.
ga_view_corners_set
(point_1, point_2, aspect_ratio)
Description: This function changes the size and center location of the current view. Input: REAL
Main Index
point_1(3)
This value specifies a point that is the location of the corner point of a box that is on a diagonal to point_2. See the remarks below for more information.
Chapter 2: Basic Functions 189 Viewing Menu
REAL
point_2(3)
This value specifies a point that is the location of the corner point of a box that is on a diagonal to point_1. See the remarks below for more information.
REAL
aspect_ratio
This value specifies the relationship between the size of the box and the zoom value applied to the view. See the remarks below for more information.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: The box defined by the input values point_1 and point_2 defines where the center of the view will be placed and along with the aspect_ratio input value, the zoom value applied to the view. The input value aspect_ratio should be a positive non-zero value. Setting the input value aspect_ratio to zero will cause a divide by zero error followed by a core dump. If the aspect_ratio is less than 0.0, the zoom factor will be set to a negative value and the results will be unpredictable. Each of the input point arrays have offsets (1, 2, 3) that correspond to the axes of the global model coordinate system (x, y, z). Example: Please see ga_view_corners_set (p. 140) in the PCL Reference Manual Examples.
Main Index
190 PCL Reference Manual Viewing Menu
ga_view_create
(name_of_view, viewport_name)
Description: This function will create a named view and post it to a viewport. Input: STRING
name_of_view[31]
This value specifies the name of the view. If this value is set to nothing or ““, an error status value will be returned by the function.
STRING
viewport_name[31]
This value specifies the name of the viewport to which the view will be posted. If this value is set to nothing or ““, the current viewport will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000153
The specified Named View already exists.
13000007
An unspecified database error occurred
13000014
Viewport not found
Remarks: None Example: Please see ga_view_create (p. 141) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 191 Viewing Menu
ga_view_delete
(name_of_view)
Description: This function deletes a named view. Input: STRING
name_of_view[31]
This value specifies the name of the view to be deleted. If this value is set to nothing or ““, the current view will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_delete (p. 143) in the PCL Reference Manual Examples.
Main Index
192 PCL Reference Manual Viewing Menu
ga_view_dist_get
(name_of_view, distance)
Description: The function will get the distance from the center of the named view to the view plane along the z axis of the global model coordinate system. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the distance will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
distance
This value returns the distance from the center of the named view to the view plane. The output value distance will always be less than the observer position distance.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_dist_get (p. 144) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 193 Viewing Menu
ga_view_dist_set
(distance)
Description: This function will set the distance from the center of the current view to the view plane along the z axis of the global model coordinate system. Input: REAL
distance
This value specifies the distance from the view plane to the center of the current view. This input value must be less than the observer position distance.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_dist_set (p. 145) in the PCL Reference Manual Examples.
Main Index
194 PCL Reference Manual Viewing Menu
ga_view_exist_get
(name_of_view, view_status)
Description: This function returns a status value reporting the existence of a named view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the distance will be obtained. If this value is set to nothing or ““, the current view will be used.
INTEGER
view_status
This value returns the status of the named view as 1 or TRUE if it exists, and 0 or false if it does not exist.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_exist_get (p. 146) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 195 Viewing Menu
ga_view_fov_get
(name_of_view, fov_angle)
Description: This function will get the field of view angle for the named view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the field of view angle will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
fov_angle
This value returns the field of view angle for the named view.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_fov_get (p. 147) in the PCL Reference Manual Examples.
Main Index
196 PCL Reference Manual Viewing Menu
ga_view_fov_set
(fov_angle)
Description: This function will set the field of view angle for the current view. Input: REAL
fov_angle
This value specifies the field of view angle.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_fov_set (p. 148) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 197 Viewing Menu
ga_view_from_get
(name_of_view, position)
Description: This function will get the position of the observer. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the position of the observer will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
position(3)
This value returns the location of the position of the observer. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z).
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
Remarks: None Example: Please see ga_view_from_get (p. 149) in the PCL Reference Manual Examples.
Main Index
198 PCL Reference Manual Viewing Menu
ga_view_from_set
(position)
Description: This function will set the position of the observer in the current view. Input: REAL
point(3)
This value specifies the position of the observer. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z).
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: This function is identical to ga_view_to_set, 214. Example: Please see ga_view_from_set (p. 150) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 199 Viewing Menu
ga_view_front_get
(name_of_view, distance)
Description: The function will get the distance from the center of the named view to the front clipping plane along the z axis of the global model coordinate system. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the distance of the front clipping plane will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
distance
This value returns the distance from the center of the named view to the front clipping plane. The output value distance will always be greater than the distance to the back clipping plane.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
Remarks: None Example: Please see ga_view_front_get (p. 151) in the PCL Reference Manual Examples.
Main Index
200 PCL Reference Manual Viewing Menu
ga_view_front_set
(distance)
Description: This function will set the distance from the center of the named view to the front clipping plane along the z axis of the global model coordinate system. Input: REAL
distance
This value specifies the distance from the center of the named view to the front clipping plane. This value must always be greater than the distance to the back clipping plane.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_front_set (p. 152) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 201 Viewing Menu
ga_view_model_scale_get
(name_of_view, scale_x, scale_y, scale_z)
Description: This function gets the model scale factors for each of the axes in the global model coordinate system of the named view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the model scale factors will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
scale_x
This value returns the scale factor for the x axis.
REAL
scale_y
This value returns the scale factor for the y axis.
REAL
scale_z
This value returns the scale factor for the z axis.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
Remarks: None Example: Please see ga_view_model_scale_get (p. 153) in the PCL Reference Manual Examples.
Main Index
202 PCL Reference Manual Viewing Menu
ga_view_model_scale_set
(scale_x, scale_y, scale_z)
Description: This function sets the model scale factors for each of the axes in the global model coordinate system of the current view. Input: REAL
scale_x
This value specifies the scale factor for the x axis.
REAL
scale_y
This value specifies the scale factor for the y axis.
REAL
scale_z
This value specifies the scale factor for the z axis.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_model_scale_set (p. 154) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 203 Viewing Menu
ga_view_nviews_get
(number_of_views)
Description: This function gets the number of views. Input: None. Output: INTEGER
number_of_views
This value returns the number of views.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000085
Cursor not open
Remarks: None Example: Please see ga_view_nviews_get (p. 155) in the PCL Reference Manual Examples.
Main Index
204 PCL Reference Manual Viewing Menu
ga_view_perspective_get
(name_of_view, perspective_status)
Description: This function gets the on/off status of the perspective for the name view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the perspective status will be obtained. If this value is set to nothing or ““, the current view will be used.
LOGICAL
perspective_status
This value returns the status of the perspective. It will either be set to on (TRUE), or off (FALSE).
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
Remarks: None Example: Please see ga_view_perspective_get (p. 156) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 205 Viewing Menu
ga_view_perspective_set
(perspective_status)
Description: This function sets the on/off status of the perspective for the current view. Input: LOGICAL
perspective_status
This value specifies the status of the perspective to be either TRUE for on, or FALSE for off.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_perspective_set (p. 157) in the PCL Reference Manual Examples.
Main Index
206 PCL Reference Manual Viewing Menu
ga_view_plane_set
(point_1, point_2, point_3)
Description: This function set a plane defined by three input points in the global model coordinate system as the current view plane in the current view. Input: REAL
point_1(3)
This value specifies the first point defining a plane.
REAL
point_2(3)
This value specifies the second point defining a plane.
REAL
point_3(3)
This value specifies the third point defining a plane.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: The offsets of the input point arrays (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z). Example: Please see ga_view_plane_set (p. 159) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 207 Viewing Menu
ga_view_rename
(original_name, new_name)
Description: This function renames a view. Input: STRING
original_name[31]
This value specifies the original name of the view. If this value is set to nothing or ““, the current view will be used.
STRING
new_name[31]
This value specifies a new name to be assigned to the view.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000153
The specified Named View already exists.
13000007
An unspecified database error occurred
Remarks: If the new name already exists, the name of the view will not be changed. Example: Please see ga_view_rename (p. 160) in the PCL Reference Manual Examples.
Main Index
208 PCL Reference Manual Viewing Menu
ga_view_sa_get
(name_of_view, angle_x, angle_y, angle_z)
Description: This function gets the absolute x, y, and z angles of rotation around the axes of the global screen coordinate system of the specified view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the absolute angles will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
angle_x
This value returns the rotation about the x axis.
REAL
angle_y
This value returns the rotation about the y axis.
REAL
angle_z
This value returns the rotation about the z axis.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_sa_get (p. 161) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 209 Viewing Menu
ga_view_sa_set
(angle_x, angle_y, angle_z)
Description: This function sets the absolute x, y, and z angles of rotation around the axes of the global screen coordinate system for the current view. Input: REAL
angle_x
This value specifies the angle of rotation for the x axis.
REAL
angle_y
This value specifies the angle of rotation for the y axis.
REAL
angle_z
This value specifies the angle of rotation for the z axis.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000014
Viewport not found
Remarks: None Example: Please see ga_view_sa_set (p. 162) in the PCL Reference Manual Examples.
Main Index
210 PCL Reference Manual Viewing Menu
ga_view_screen_scale_get
(name_of_view, scale_x, scale_y)
Description: This function gets the model scale factors for each of the axes in the global screen coordinate system of the named view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the screen scale factors will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
scale_x
This value returns the scale factor for the x axis.
REAL
scale_y
This value returns the scale factor for the y axis.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
Remarks: None Example: Please see ga_view_screen_scale_get (p. 163) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 211 Viewing Menu
ga_view_screen_scale_set
(scale_x, scale_y)
Description: This function sets the screen scale factors for each of the axes in the global screen coordinate system of the current view. Input: REAL
scale_x
This value specifies the scale factor for the x axis.
REAL
scale_y
This value specifies the scale factor for the y axis.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_screen_scale_set (p. 164) in the PCL Reference Manual Examples.
Main Index
212 PCL Reference Manual Viewing Menu
ga_view_sr_set
(angle_x, angle_y, angle_z)
Description: This function sets the relative x, y, and z angles of rotation around the axes of the global screen coordinate system for the current view. Input: REAL
angle_x
This value specifies the angle of rotation for the x axis.
REAL
angle_y
This value specifies the angle of rotation for the y axis.
REAL
angle_z
This value specifies the angle of rotation for the z axis.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000132
There is no current view.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None Example: Please see ga_view_sr_set (p. 165) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 213 Viewing Menu
ga_view_to_get
(name_of_view, center_point)
Description: This function returns the center point of the named view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the center point will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
center_point(3)
This value returns the location of the center point of the view. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z).
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000132
There is no current view.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
Remarks: None Example: Please see ga_view_to_get (p. 167) in the PCL Reference Manual Examples.
Main Index
214 PCL Reference Manual Viewing Menu
ga_view_to_set
(point)
Description: This function will set the position of the observer in the current view. Input: REAL
point(3)
This value sets the position of the observer. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z).
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: This function is identical to the function ga_view_from_set. Example: Please see ga_view_to_set (p. 168) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 215 Viewing Menu
ga_view_up_get
(name_of_view, direction_vector)
Description: This function returns a point that is on a vector normal to the view plane of the named view that defines the up direction of the view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the direction vector will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
direction_vector(3)
This value returns the location of a point on a vector normal to the view plane defining the up direction of the view. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z).
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_up_get (p. 169) in the PCL Reference Manual Examples.
Main Index
216 PCL Reference Manual Viewing Menu
ga_view_up_set
(direction_vector)
Description: This function defines the up direction in a view by setting a point that is on a vector normal to the view plane of the current view. Input: REAL
direction_vector(3)
This value specifies the location of a point on a vector normal to the view plane defining the up direction of the view. The offsets of the array (1, 2, 3) correspond to the axes of the global model coordinate system (x, y, z).
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000013
View not found
Remarks: None Example: Please see ga_view_up_set (p. 170) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 217 Viewing Menu
ga_view_views_get
(view_list)
Description: This function gets a list of all of the named views. Input: None. Output: STRING
view_list[31]()
This value returns a list of all of the view. The number of offsets allocated for this array should match the number of viewports. See the remarks below for more information.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
13000085
Cursor not open
Remarks: The number of viewports can be found through a call to the function ga_viewport_view_get. Example: Please see ga_view_views_get (p. 171) in the PCL Reference Manual Examples.
Main Index
218 PCL Reference Manual Viewing Menu
ga_view_zoom_get
(name_of_view, zoom_factor)
Description: This function will get the zoom factor for the named view. Input: STRING
name_of_view[31]
This value specifies the name of the view from which the zoom factor will be obtained. If this value is set to nothing or ““, the current view will be used.
REAL
zoom_factor
This value returns the zoom factor for the named view.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000058
The view name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
Remarks: None Example: Please see ga_view_zoom_get (p. 172) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 219 Viewing Menu
ga_view_zoom_set
(zoom_factor)
Description: This function will set the current zoom factor for the current view. Input: REAL
zoom_factor
This value specifies the new zoom factor to which the current view will be set. The zoom factor value must be between 1e-32 and 1e+32 or otherwise function will return an error.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000103
The specified view was not found in the data base.
11000132
There is no current view.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_view_zoom_set (p. 173) in the PCL Reference Manual Examples.
Main Index
220 PCL Reference Manual Viewport Menu
Viewport Menu This section is used to describe functions that are used to create, delete, modify and retrieve the settings of named viewports. A viewport is a named graphics window in which portions of a model’s geometry, finite elements, and analysis results are displayed. The data that defines a viewport is stored in the database. The viewport will display several pieces of information in its title bar: the name of the model database, the viewport name, the current group name, and the display method. The following functions can be used to change, create, and delete viewports and many of the attributes associated with them. Each of these functions modify and/or retrieve information from the database. The act of posting a viewport or an attribute of a viewport will set that viewport or attribute as being selected for display and will cause the display to be updated as needed.
ga_viewport_axis_get
(viewport_name, axis_display)
Description: This function will return a value from the database indicating if a coordinate axis should be displayed in a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport.
INTEGER
axis_display
This value returns the status of the coordinate axis display in the viewport. It will be set to TRUE or 1 if the coordinate axis should be displayed and FALSE or 0 if it should not.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000004
GaErrDuplicate entry exists in table
13000007
An unspecified database error occurred
13000014
Viewport not found
Remarks:
Main Index
Chapter 2: Basic Functions 221 Viewport Menu
If the input value viewport_name is set to nothing or “”, the current viewport is used. Example: Please see ga_viewport_axis_get (p. 81) in the PCL Reference Manual Examples.
ga_viewport_axis_set
(viewport_name, axis_display)
Description: This function will set a value in the database used to indicate if a coordinate axis display should be shown in the viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport.
INTEGER
axis_display
This value should be set to TRUE or 1 if the coordinate axis should be displayed and FALSE or 0 if it should not.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000004
GaErrDuplicate entry exists in table
13000007
An unspecified database error occurred
13000014
Viewport not found
Remarks: If the input value viewport_name is set to nothing or “”, the current viewport is used. Example: Please see ga_viewport_axis_set (p. 82) in the PCL Reference Manual Examples.
Main Index
222 PCL Reference Manual Viewport Menu
ga_viewport_background_get
(viewport_name, background_color)
Description: This function will get the background color of a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport.
INTEGER
background_color
This value returns the background color for the viewport.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000004
GaErrDuplicate entry exists in table
13000007
An unspecified database error occurred
13000014
Viewport not found
Remarks: If the input value viewport_name is set to nothing or “”, the current viewport is used. Example: Please see ga_viewport_background_get (p. 83) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 223 Viewport Menu
ga_viewport_background_set
(viewport_name, background_color)
Description: This function will set and post the background color of a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport.
INTEGER
background_color
This value specifies the background color for the viewport.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000004
GaErrDuplicate entry exists in table
13000007
An unspecified database error occurred
13000014
Viewport not found
Remarks: If the input value viewport_name is set to nothing or “”, the current viewport is used. Example: Please see ga_viewport_background_set (p. 84) in the PCL Reference Manual Examples.
Main Index
224 PCL Reference Manual Viewport Menu
ga_viewport_create
(viewport_name, x_location, y_location, width, height)
Description: This function will create, set the active group to the current group, make current, and post a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport.
REAL
x_location
This value specifies the X axis location of the upper left corner of the viewport relative to the upper left corner of the screen.
REAL
y_location
This value specifies the Y axis location of the upper left corner of the viewport relative to the upper left corner of the screen.
REAL
width
This value specifies the width of the viewport.
REAL
height
This value specifies the height of the viewport.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000006
A viewport with the given name is already in the database.
11000007
The viewport name is invalid.
11000008
The location of the viewport is out of range
11000009
The size of the viewport is out of range
11000097
There is not enough disk space to complete operation.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000013
View not found
Remarks: An input value viewport_name value of nothing or “” is not allowed and will return an error. The input values x_location, y_location, width, and height must all be positive.
Main Index
Chapter 2: Basic Functions 225 Viewport Menu
Example: Please see ga_viewport_create (p. 85) in the PCL Reference Manual Examples.
ga_viewport_current_get
(viewport_name)
Description: This function will get the name of the current viewport. Input: None. Output: STRING
viewport_name[31]
This value returns the name of the current viewport.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000014
Viewport not found
Remarks: None. Example: Please see ga_viewport_current_get (p. 87) in the PCL Reference Manual Examples.
Main Index
226 PCL Reference Manual Viewport Menu
ga_viewport_current_set
(viewport_name)
Description: This function will set the name of the current viewport. Input: STRING
viewport_name[31]
This value specifies the name of the current viewport.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_viewport_current_set (p. 88) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 227 Viewport Menu
ga_viewport_delete
(viewport_name)
Description: This function deletes the named viewport. Input: STRING
viewport_name[31]
This value specify the name of the viewport to be deleted.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000095
The specified operation cannot be performed on the current viewport.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_viewport_delete (p. 89) in the PCL Reference Manual Examples.
Main Index
228 PCL Reference Manual Viewport Menu
ga_viewport_exist_get
(viewport_name, existance_flag)
Description: This function can be used to find out if a viewport with a specified name exists. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to be checked for existence.
INTEGER
existance_flag
This value returns TRUE or 1 if the named viewport exists, and FALSE or 0 if it does not.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000095
The specified operation cannot be performed on the current viewport.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_viewport_exist_get (p. 90) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 229 Viewport Menu
ga_viewport_group_post
(viewport_name, group_name)
Description: This function posts a group to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to which the group will be posted. If this value is set to nothing or ““, the current viewport will be used.
STRING
group_name[31]
This value specifies the name of the group to be posted. If this value is set to nothing or ““, the current viewport will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000050
The group name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000122
The group has already been posted to the viewport.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
Remarks: None. Example: Please see ga_viewport_group_post (p. 91) in the PCL Reference Manual Examples.
Main Index
230 PCL Reference Manual Viewport Menu
ga_viewport_group_post_all
(viewport_name)
Description: This function posts all defined groups to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to which the group will be posted. If this value is set to nothing or ““, the current viewport will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
11000105
The specified group was not found in the database.
11000122
The group has already been posted to the viewport.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
Remarks: None. Example: Please see ga_viewport_group_post_all (p. 92) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 231 Viewport Menu
ga_viewport_group_unpost
(viewport_name, group_name)
Description: This function unposts a group from a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to which the group will be posted. If this value is set to nothing or ““, the current viewport will be used.
STRING
group_name[31]
This value specifies the name of the group to be unposted. If this value is set to nothing or ““, the current viewport will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000050
The group name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
11000105
The specified group was not found in the database.
11000121
There is not a current group defined.
11000122
The group has already been posted to the viewport.
11000124
Group cannot be unposted from viewport not posted to.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000014
Viewport not found
Remarks: None. Example: Please see ga_viewport_group_unpost (p. 93) in the PCL Reference Manual Examples.
Main Index
232 PCL Reference Manual Viewport Menu
ga_viewport_group_unpost_all
(viewport_name)
Description: This function will unpost all posted groups from a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to which the group will be unposted. If this value is set to nothing or ““, the current viewport will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000100
The specified viewport was not found in the database.
11000105
The specified group was not found in the database.
11000125
The viewport has no groups posted to it.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
Remarks: None. Example: Please see ga_viewport_group_unpost_all (p. 94) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 233 Viewport Menu
ga_viewport_groups_get
(viewport_name, group_list)
Description: This function gets the groups posted to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the group list will be made. If this value is set to nothing or ““, the current viewport will be used.
STRING
group_list[31]()
This value returns a list of group names posted to the viewport. The number of offsets allocated for this array should match the number of groups posted to this viewport. See the remarks below for more information.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
11000114
There are no groups posted to the viewport.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000008
Group not found
13000085
Cursor not open
Remarks: The number of groups posted to this viewport can be obtained through a call to the function ga_viewport_ngroups_get. Example: Please see ga_viewport_groups_get (p. 95) in the PCL Reference Manual Examples.
Main Index
234 PCL Reference Manual Viewport Menu
ga_viewport_light_post
(viewport_name, light)
Description: This function posts a light source to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to which the light source will be posted. If this value is set to nothing or ““, the current viewport will be used.
STRING
light[31]
This value specifies the name of a light source.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000036
A light source with the given name is already in the database.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000104
The specified light source was not found in the database.
13000010
Light source not found
13000014
Viewport not found
Remarks: Currently, this function does nothing. Example: Please see ga_viewport_light_post (p. 95) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 235 Viewport Menu
ga_viewport_light_unpost
(name, light)
Description: This function unposts a light source from a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to which the light source will be unposted. If this value is set to nothing or ““, the current viewport will be used.
STRING
light[31]
This value specifies the name of a light source.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000036
A light source with the given name is already in the database.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000104
The specified light source was not found in the database.
13000010
Light source not found
13000014
Viewport not found
Remarks: Currently, this function does nothing. Example: Please see ga_viewport_light_unpost (p. 97) in the PCL Reference Manual Examples.
Main Index
236 PCL Reference Manual Viewport Menu
ga_viewport_lights_get
(viewport_name, light_list)
Description: This function gets a list of light source names posted to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the list of light sources will be made. If this value is set to nothing or ““, the current viewport will be used.
STRING
light_list[31]()
This value returns a list of light source names posted to the viewport. The number of offsets allocated for this array should match the number of light sources posted to this viewport. See the remarks below for more information.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
11000113
There are no light sources posted to the viewport.
13000014
Viewport not found
Remarks: The number of light source names currently posted to a viewport can be found through a call to the function ga_viewport_nlights_get. Currently, this function does nothing to the contents of the input value light_list. Example: Please see ga_viewport_lights_get (p. 98) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 237 Viewport Menu
ga_viewport_location_get
(viewport_name, x, y)
Description: This function gets the viewport location relative to the upper left corner of the parent graphics window. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the location will be retrieved. If this value is set to nothing or ““, the current viewport will be used.
REAL
x
This value returns the viewport X position.
REAL
y
This value returns the viewport Y position.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000014
Viewport not found
Remarks: None. Example: Please see ga_viewport_location_get (p. 99) in the PCL Reference Manual Examples.
Main Index
238 PCL Reference Manual Viewport Menu
ga_viewport_location_set
(viewport_name, x, y, update_control)
Description: This function sets and optionally posts the viewport location relative to the upper left corner of the parent graphics window. Input: STRING
viewport_name[31]
This value specifies the name of the viewport that will have its location set. If this value is set to nothing or ““, the current viewport will be used.
REAL
x
This value specifies the viewport X position and it must be a positive number.
REAL
y
This value specifies the viewport Y position and it must be a positive number.
INTEGER
update_control
This value specifies the method used to update or post the display with the new location information. When this value is set to 1 or TRUE, the viewport will be updated immediately. If the this value is set to 0 or FALSE, updating the viewport will be deferred until another graphics manager event takes place. It is recommended that this value always be set to 1 or TRUE.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000008
The location of the viewport is out of range
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_location_set (p. 100) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 239 Viewport Menu
ga_viewport_ngroups_get
(viewport_name, number_of_groups)
Description: This function will get the number of groups posted to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the number of groups assigned to the viewport will be obtained. If this value is set to nothing or ““, the current viewport will be used.
INTEGER
number_of_groups
This value returns the number of groups assigned to a viewport.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000100
The specified viewport was not found in the database.
11000098
A fatal error has occurred in the database. Database is corrupted.
Remarks: None. Example: Please see ga_viewport_ngroups_get (p. 102) in the PCL Reference Manual Examples.
Main Index
240 PCL Reference Manual Viewport Menu
ga_viewport_nlights_get
(viewport_name, number_of_lights)
Description: This function will get the number of lights posted to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the number of light sources assigned to the viewport will be obtained. If this value is set to nothing or ““, the current viewport will be used.
INTEGER
number_of_lights
This value returns the number of light sources assigned to a viewport.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: Currently, this function does nothing and will not modify the initial value of the output value number_of_lights. Example: Please see ga_viewport_nlights_get (p. 102) in the PCL Reference Manual Examples
Main Index
Chapter 2: Basic Functions 241 Viewport Menu
ga_viewport_nposted_get
(number_of_viewports)
Description: This function will get the number of viewports that have been marked as posted. Input: None. Output: INTEGER
number_of_viewports
This value returns the number of posted viewports.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
Remarks: None. Example: Please see ga_viewport_nposted_get (p. 104) in the PCL Reference Manual Examples.
Main Index
242 PCL Reference Manual Viewport Menu
ga_viewport_nviewports_get
(number_of_viewports)
Description: This function will get the number of viewports that have been defined in the database. Input: None. Output: INTEGER
number_of_viewports
This value returns the number of viewports.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
Remarks: None. Example: Please see ga_viewport_nviewports_get (p. 105) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 243 Viewport Menu
ga_viewport_origin_get
(viewport_name, origin_status)
Description: This function will get the status of a value used to state if a symbol should be displayed at the origin of the global coordinate system for a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport that will be checked for the state of the origin symbol. If this value is set to nothing or ““, the current viewport will be used.
INTEGER
origin_status
This value returns the status value used to indicate if a coordinate system origin symbol should be displayed. This value will be set to 1 or TRUE if the coordinate system origin should be displayed, 0 or FALSE if it should not be displayed.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000014
Viewport not found
Remarks: None. Example: Please see ga_viewport_origin_get (p. 106) in the PCL Reference Manual Examples.
Main Index
244 PCL Reference Manual Viewport Menu
ga_viewport_origin_set
(viewport_name, origin_status)
Description: This function will set and post the status of a value used to state if a symbol should be displayed at the origin of the global coordinate system for a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport that will have its coordinate system origin state set. If this value is set to nothing or ““, the current viewport will be used.
INTEGER
origin_status
This value specifies the status value used to indicate if a coordinate system origin symbol should be displayed. This value should be set to either 1 or TRUE if the coordinate system origin should be displayed, or 0 or FALSE if it should not.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000014
Viewport not found
Remarks: None. Example: Please see ga_viewport_origin_set (p. 107) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 245 Viewport Menu
ga_viewport_post
(viewport_name)
Description: This function will post a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport that will have its coordinate system origin state set. If this value is set to nothing or ““, the current viewport will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
13000014
Viewport not found
Remarks: None. Example: Please see ga_viewport_post (p. 108) in the PCL Reference Manual Examples.
Main Index
246 PCL Reference Manual Viewport Menu
ga_viewport_posted_get
(viewport_list)
Description: This function will get a list of all of the posted viewports. Input: None. Output: STRING
viewport_list[31]()
This value returns a list of all of the posted viewports. The number of offsets allocated for this array should match the number of posted viewports. See the remarks below for more information.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: The number of posted viewports can be found through a call to the function ga_viewport_nposted_get. Example: Please see ga_viewport_posted_get (p. 109) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 247 Viewport Menu
ga_viewport_range_get
(viewport_name, range)
Description: This function will get the name of the range of numeric values used in conjunction with spectrums for displaying results posted to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the range assigned to the viewport will be obtained. If this value is set to nothing or ““, the current viewport will be used.
STRING
range[31]
This value returns the name of the range posted to the specified viewport.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_range_get (p. 110) in the PCL Reference Manual Examples.
Main Index
248 PCL Reference Manual Viewport Menu
ga_viewport_range_set
(viewport_name, range)
Description: This function will set and post the name of the range of numeric values used in conjunction with spectrums for displaying results to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the range assigned to the viewport will be obtained. If this value is set to nothing or ““, the current viewport will be used.
STRING
range[31]
This value specifies the name of the range that will be set and posted to the viewport. If this value is set to nothing or ““, the current range will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_range_set (p. 111) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 249 Viewport Menu
ga_viewport_rename
(original_name, new_name)
Description: This function will rename a viewport. Input: STRING
original_name[31]
This value specifies the original name of the viewport. Setting this value to nothing or ““to identify the current viewport does not work here and will generate an error.
STRING
new_name[31]
This value specifies the new viewport name.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_rename (p. 112) in the PCL Reference Manual Examples.
Main Index
250 PCL Reference Manual Viewport Menu
ga_viewport_size_get
(viewport_name, width, height)
Description: This function gets the width and height of a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the height and width will be obtained. If this value is set to nothing or ““, the current viewport will be used.
REAL
width
This value returns the viewport width.
REAL
height
This value returns the viewport height.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_size_get (p. 113) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 251 Viewport Menu
ga_viewport_size_set
(viewport_name, width, height, update_control)
Description: This function sets the width and height of a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the height and width will be obtained. If this value is set to nothing or ““, the current viewport will be used.
REAL
width
This value specifies the width of the viewport and must be greater than or equal to 1.0.
REAL
height
This value specifies the height of the viewport and must be greater than or equal to 1.0.
INTEGER
update_control
This value specifies the method used to update or post the display with the new size information. When this value is set to 1 or TRUE, the viewport will be updated immediately. If the this value is set to 0 or FALSE, updating the viewport will be deferred until another graphics manager event takes place. It is recommended that this value always be set to 1 or TRUE.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000009
The size of the viewport is out of range.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_size_set (p. 114) in the PCL Reference Manual Examples.
Main Index
252 PCL Reference Manual Viewport Menu
ga_viewport_spectrum_get
(viewport_name, spectrum_status)
Description: This function gets the current value of an integer intended to be used to record the posting status of the current spectrum for a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the posting status of the current spectrum will be obtained. If this value is set to nothing or ““, the current viewport will be used.
INTEGER
spectrum_status
This value returns the status of the integer intended for use in recording the posting status of the current spectrum to a viewport.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_spectrum_get (p. 116) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 253 Viewport Menu
ga_viewport_spectrum_set
(viewport_name, spectrum_status)
Description: This function is used to set the value of an integer intended to be used to record the posting status of the current spectrum for a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to which the posting status of the current spectrum will be set. If this value is set to nothing or ““, the current viewport will be used.
INTEGER
spectrum_status
This value specifies the status of the integer intended for use in recording the posting status of the current spectrum to a viewport.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_spectrum_set (p. 117) in the PCL Reference Manual Examples.
Main Index
254 PCL Reference Manual Viewport Menu
ga_viewport_title_post
(viewport_name, title)
Description: This function will post a title to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the title will be posted. If this value is set to nothing or ““, the current viewport will be used.
STRING
title[256]
This value specifies the title that will be posted to the viewport.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000004
Duplicate entry exists in table
13000014
Viewport not found
13000135
The specified VP title was not found.
Remarks: None. Example: Please see ga_viewport_title_post (p. 118) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 255 Viewport Menu
ga_viewport_title_unpost
(viewport_name, title)
Description: This function will unpost a title from a viewport and delete the title from the database. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the title will be unposted. If this value is set to nothing or ““, the current viewport will be used.
STRING
title[256]
This value specifies the title that will be unposted from the viewport.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000014
Viewport not found
13000135
The specified VP title was not found.
Remarks: None. Example: Please see ga_viewport_title_unpost (p. 119) in the PCL Reference Manual Examples.
Main Index
256 PCL Reference Manual Viewport Menu
ga_viewport_unpost
(viewport_name)
Description: This function will unpost a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport that will be marked as unposted. If this value is set to nothing or ““, the current viewport will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
Remarks: None. Example: Please see ga_viewport_unpost (p. 121) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 257 Viewport Menu
ga_viewport_view_get
(name_of_view, viewport_name)
Description: This function will assign a view name to the current view parameters of a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the current view parameters will be obtained. If this value is set to nothing or ““, the current viewport will be used.
STRING
name_of_view[31]
This value specifies the name of the view to which the current view parameters of the viewport will be assigned.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000058
The view name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
11000103
The specified view was not found in the data base.
Remarks: This function is a little different as it is named in a manner that suggests that it should return information retrieved from the database in an output argument. Instead of returning information in an output argument, this function retrieves information about a viewport from the database and then assigns a view name to that information in the database. See the listing for this function in Broken, Obsolete, Modified and New Functions for further information. Example: Please see ga_viewport_view_get (p. 122) in the PCL Reference Manual Examples.
Main Index
258 PCL Reference Manual Viewport Menu
ga_viewport_view_name
(viewport_name, name_of_view)
Description: This function will get the name of the view of a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport from which the name of the view will be obtained. If this value is set to nothing or ““, the current viewport will be used.
STRING
name_of_view[31]
This value returns the name of the view for the specified viewport.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000096
A current viewport has not been defined.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
11000116
No view has been assigned to the viewport.
Remarks: See the listing for this function in Broken, Obsolete, Modified and New Functions for further information. Example: Please see ga_viewport_view_name (p. 123) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 259 Viewport Menu
ga_viewport_view_set
(name_of_view, viewport_name)
Description: This function will post a view to a viewport. Input: STRING
viewport_name[31]
This value specifies the name of the viewport to which the view will be posted. If this value is set to nothing or ““, the current viewport will be used.
STRING
name_of_view[31]
This value specifies the name of the view that will be posted to the viewport. If this value is set to nothing or ““, the current view will be used.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000007
The viewport name is invalid.
11000058
The view name is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000100
The specified viewport was not found in the database.
11000103
The specified view was not found in the data base.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000013
View not found
Remarks: None. Example: Please see ga_viewport_view_set (p. 124) in the PCL Reference Manual Examples.
Main Index
260 PCL Reference Manual Viewport Menu
ga_viewport_viewports_get
(viewport_list)
Description: This function gets a list of all of the viewports, including viewports that have not been posted. Input: None. Output: STRING
viewport_list[31]()
This value returns a list of all of the viewports. The number of offsets allocated for this array should match the number of viewports. See the remarks below for more information.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
Remarks: The number of viewports can be found through a call to the function ga_viewport_nviewports_get. Example: Please see ga_viewport_viewports_get (p. 125) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 261 Display Menu
PCL Reference Manual Chapter 2: Basic Fun ctions
Display Menu This section is used to describe functions that are used to control the values stored in the database that govern what and how geometric and finite element model entities are displayed in a viewport.
ga_display_autosubdivconst_get
(display_name, tolerance)
Description: This function gets the subdivision tolerance value used in conjunction with setting the ranges for spectrums used to display results. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
REAL
tolerance
This value returns the range subdivision tolerance value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000016
Display not found
Remarks: None. Example: Please see ga_display_autosubdivconst_get (p. 175) in the PCL Reference Manual Examples.
Main Index
262 PCL Reference Manual Display Menu
ga_display_autosubdivconst_set
(display_name, tolerance)
Description: This function sets the subdivision tolerance value used in conjunction with setting the ranges for spectrums used to display results. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
tolerance
This value specifies the range subdivision tolerance value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_autosubdivconst_set (p. 176) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 263 Display Menu
ga_display_autosubdivide_get
(display_name, autosubdivide_status)
Description: This function gets the status of the autosubdivide flag used in storing the value of a setting for the range used with spectrums used to display results. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
autosubdivide_status
This value returns the autosubdivide and can be any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_autosubdivide_get (p. 178) in the PCL Reference Manual Examples.
Main Index
264 PCL Reference Manual Display Menu
ga_display_autosubdivide_set
(display_name, autosubdivide_status)
Description: This function sets the status of the autosubdivide flag used in storing the value of a setting for the range used with spectrums to display results. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
autosubdivide_status
This value specifies the autosubdivide status and can be set to any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_autosubdivide_set (p. 179) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 265 Display Menu
ga_display_backfacing_get
(display_name, backface_status)
Description: This function gets the status of the value used to control the display of back facing polygons. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
backface_status
This value returns the status for the display of back facing polygons. This argument may be set to any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_backfacing_get (p. 180) in the PCL Reference Manual Examples.
Main Index
266 PCL Reference Manual Display Menu
ga_display_backfacing_set
(display_name, backface_status)
Description: This function sets the value used to control the display of back facing polygons. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
backface_status
This value specifies the status for the display of back facing polygons. It can be set to any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_backfacing_set (p. 182) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 267 Display Menu
ga_display_bumpmap_get
(display_name, bump_map_id, bump_map_number)
Description: This function gets the bump map parameters for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
bump_map_id
This value returns the bump map ID.
INTEGER
bump_map_number
This value returns the number of bump maps per surface.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_bumpmap_get (p. 183) in the PCL Reference Manual Examples.
Main Index
268 PCL Reference Manual Display Menu
ga_display_bumpmap_set
(display_name, bump_map_id, bump_map_number)
Description: This function sets the bump map parameters for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
bump_map_id
This value specifies the ID number identifying a specific bump map.
INTEGER
bump_map_number
This value specifies the number of bump maps per surface.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_bumpmap_set (p. 184) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 269 Display Menu
ga_display_contour_lblspcng_get
(display_name, label_spacing)
Description: This function gets the label spacing for contour plots from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
label_spacing
This value returns the label spacing for contour plots. This value will always be greater than zero.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_contour_lblspcng_get (p. 186) in the PCL Reference Manual Examples.
Main Index
270 PCL Reference Manual Display Menu
ga_display_contour_lblspcng_set
(display_name, label_spacing)
Description: This function sets the label spacing for contour plots for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
label_spacing
This value specifies the label spacing for contour plots. This value must be greater than zero or an error condition will be returned.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000091
The specified contour label spacing is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_contour_lblspcng_set (p. 187) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 271 Display Menu
ga_display_create
(display_name)
Description: This function will create a named display property list using display property list assigned the current group for its default values. Input: STRING
display_name[31]
This value specifies the name of the display property list to be created.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000041
A display property list with the given name is already in the database.
11000042
The display property list is invalid.
11000097
There is not enough disk space to complete operation.
11000098
A fatal error has occurred in the database. Database is corrupted.
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_create (p. 188) in the PCL Reference Manual Examples.
Main Index
272 PCL Reference Manual Display Menu
ga_display_deform_scale_get
(display_name, deformation_scale)
Description: This function gets the deformation scale for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
REAL
deformation_scale
This value returns the deformation scale value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_deform_scale_get (p. 189) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 273 Display Menu
ga_display_deform_scale_set
(display_name, deformation_scale)
Description: This function sets the deformation scale for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
deformation_scale
This value specifies the deformation scale for the named display property list.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_deform_scale_set (p. 191) in the PCL Reference Manual Examples.
Main Index
274 PCL Reference Manual Display Menu
ga_display_deform_scalintrp_get
(display_name, interpretation)
Description: This function gets the interpretation of the deformation scale for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
STRING
interpretation[31]
This value returns the deformation scale interpretation string which can have a value of either “VALUE”, or “PERCENTAGE”.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_deform_scalintrp_get (p. 192) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 275 Display Menu
ga_display_deform_scalintrp_set
(display_name, interpretation)
Description: This function will set the interpretation value for the deformed entity scale for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
interpretation[31]
This value specifies the interpretation value. This string can have either be set to “VALUE” or “PERCENTAGE”.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000093
The specified deform scale interpretation is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_deform_scalintrp_set (p. 193) in the PCL Reference Manual Examples.
Main Index
276 PCL Reference Manual Display Menu
ga_display_delete
(display_name)
Description: This function will delete the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
11000141
The Display Property is in use by the model or is assigned to a group.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_delete (p. 194) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 277 Display Menu
ga_display_diffuse_get
(display_name, diffuse_reflectance)
Description: This function will get the diffuse reflectance value for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
REAL
diffuse_reflectance
This value returns the diffuse reflectance value for the named display property list.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_diffuse_get (p. 195) in the PCL Reference Manual Examples.
Main Index
278 PCL Reference Manual Display Menu
ga_display_diffuse_set
(display_name, diffuse_reflectance)
Description: Set the diffuse reflectance. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
diffuse_reflectance
This value specifies the diffuse reflectance for the named display property list.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_diffuse_set (p. 197) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 279 Display Menu
ga_display_displays_get
(display_list)
Description: This function will get a list of all of the defined named display property lists. Input: None. Output: STRING
display_list[31]()
This value returns a list of all defined display property lists. See the remarks below for more information.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
13000085
Cursor not open
Remarks: The output value display_list must be allocated with enough offsets available to contain the entire list. The number of offsets needed can be obtained through a call to the function ga_display_ndisplays_get. Example: Please see ga_display_displays_get (p. 198) in the PCL Reference Manual Examples.
Main Index
280 PCL Reference Manual Display Menu
ga_display_edgecolor_get
(display_name, color_index)
Description: This function will get the edge color attributes used in shading for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
color_index
This value returns the color index for the edges of the named display property list.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_edgecolor_get (p. 199) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 281 Display Menu
ga_display_edgecolor_set
(display_name, color_index)
Description: This function will set the edge color attributes used in shading for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_index
This value specifies the edge color attributes for the named display property list.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_edgecolor_set (p. 200) in the PCL Reference Manual Examples.
Main Index
282 PCL Reference Manual Display Menu
ga_display_exist_get
(display_name, display_status)
Description: This function is used to check for the existence of a named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
display_status
This value returns the existence of the named display property list. It will be set to 0 or FALSE if the list does not exist and it will be set to 1 or TRUE if the list exists.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_exist_get (p. 201) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 283 Display Menu
ga_display_freefem_get
(display_name, style)
Description: This function will get the free FEM characteristics display style attribute from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
style
This value returns the free FEM display style for the named display property list.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_freefem_get (p. 202) in the PCL Reference Manual Examples.
Main Index
284 PCL Reference Manual Display Menu
ga_display_freefem_set
(display_name, style)
Description: This function will set the free FEM characteristics display style attribute for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
style
This value specifies the free FEM display style for the named display property list.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_freefem_set (p. 204) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 285 Display Menu
ga_display_gloss_get
(display_name, gloss_value)
Description: This function will get the amount of glossiness for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
REAL
gloss_value
This value returns the gloss value for the named display property list.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_gloss_get (p. 205) in the PCL Reference Manual Examples.
Main Index
286 PCL Reference Manual Display Menu
ga_display_gloss_set
(display_name, gloss_value)
Description: This function will set the amount of gloss for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
gloss_value
This value specifies the gloss for the named display property list.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_gloss_set (p. 207) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 287 Display Menu
ga_display_gravitation_get
(display_name, gravity_status)
Description: This function gets the on/off status for the display of gravitational points for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
gravity_status
This value returns the on/off status for the display of gravitational points and can be of any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_gravitation_get (p. 208) in the PCL Reference Manual Examples.
Main Index
288 PCL Reference Manual Display Menu
ga_display_gravitation_set
(display_name, gravity_status)
Description: This function sets the on/off status for the display of gravitational points for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
gravity_status
This value specifies the on/off status used to control the display of gravitational points and can be of any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_gravitation_set (p. 209) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 289 Display Menu
ga_display_hilight_get
(display_name, specular_value)
Description: This function will get the value used to control specular reflections for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
specular_value
This value returns the state of the value used to control specular reflections.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_hilight_get (p. 210) in the PCL Reference Manual Examples.
Main Index
290 PCL Reference Manual Display Menu
ga_display_hilight_set
(display_name, specular_value)
Description: This function will set the value used to control specular reflections for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
specular_value
This value specifies the state of the value used to control specular reflections.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_hilight_set (p. 211) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 291 Display Menu
ga_display_labelcolor_get
(display_name, label_color)
Description: This function will get the label color for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
label_color
This value returns the label color for the named display property list.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_labelcolor_get (p. 213) in the PCL Reference Manual Examples.
Main Index
292 PCL Reference Manual Display Menu
ga_display_labelcolor_set
(display_name, label_color)
Description: This function sets the label color for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
label_color
This value specifies the label color.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_labelcolor_set (p. 214) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 293 Display Menu
ga_display_lines_get
(display_name, line_number)
Description: This function gets the number of visualization lines from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
line_number
This value returns the number of visualization lines.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_lines_get (p. 215) in the PCL Reference Manual Examples.
Main Index
294 PCL Reference Manual Display Menu
ga_display_lines_set
(display_name, line_number)
Description: This function will set the number of visualization lines for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
line_number
This value specifies the number of visualization lines.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_lines_set (p. 217) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 295 Display Menu
ga_display_linestyle_get
(display_name, line_style)
Description: This function will get the line style for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
STRING
line_style[31]
This value returns one of the two values, “SOLID”, or “DASHED”, that are used to specify the line style.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_linestyle_get (p. 218) in the PCL Reference Manual Examples.
Main Index
296 PCL Reference Manual Display Menu
ga_display_linestyle_set
(display_name, line_style)
Description: Set the curve style. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
line_style[31]
This value specifies the line_style and it should be set to one of the two supported values: “SOLID”, or “DASHED”. These two values are not case sensitive.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000043
The specified line style is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_linestyle_set (p. 219) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 297 Display Menu
ga_display_linewidth_get
(display_name, line_width)
Description: This function will get the line width for the named display property list. See remarks below. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
line_width
This value returns the line width for the named display property list.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: This function does nothing and does not modify the initial value of the input value line_width. Example: Please see ga_display_linewidth_get (p. 220) in the PCL Reference Manual Examples.
Main Index
298 PCL Reference Manual Display Menu
ga_display_linewidth_set
(display_name, line_width)
Description: This function will set the line width for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
line_width
This value specifies the line width for the named display property list.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: This function does nothing and does not make any use of the input value line_width. Example: Please see ga_display_linewidth_set (p. 221) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 299 Display Menu
ga_display_ndisplays_get
(number_of_displays)
Description: This function will get the number of named display properties currently defined. Input: None. Output: INTEGER
number_of_displays
This value returns the number of display properties.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000098
A fatal error has occurred in the database. Database is corrupted.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
13000085
Cursor not open
Remarks: None. Example: Please see ga_display_ndisplays_get (p. 222) in the PCL Reference Manual Examples.
Main Index
300 PCL Reference Manual Display Menu
ga_display_nlspc_get
(display_name, number_of_segments)
Description: This function will get the number of line segments per curve for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
number_of_segments
This value returns the number of line segments per curve.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_nlspc_get (p. 223) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 301 Display Menu
ga_display_nlspc_set
(display_name, number_of_segments)
Description: This function will set the number of line segments per curve for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
number_of_segments
This value specifies the number of line segments per curve.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_nlspc_set (p. 224) in the PCL Reference Manual Examples.
Main Index
302 PCL Reference Manual Display Menu
ga_display_nspe_get
(display_name, number_of_segments)
Description: This function will get the number of line segments per edge for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
number_of_segments
This argument returns the number of line segments per edge.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_nspe_get (p. 226) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 303 Display Menu
ga_display_nspe_set
(display_name, number_of_segments)
Description: This function will set the number of line segments per edge for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
number_of_segments
This values specifies the number of line segments per edge.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_nspe_set (p. 227) in the PCL Reference Manual Examples.
Main Index
304 PCL Reference Manual Display Menu
ga_display_offsets_get
(display_name, offset_status)
Description: This function controls the on/off status of the offset for the display of element properties for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
offset_status
This argument returns the on/off status of the offset for the display of element properties. This argument may be any of any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_offsets_get (p. 229) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 305 Display Menu
ga_display_offsets_set
(display_name, offset_status)
Description: This function will set the on/off status of the offset for the display of element properties for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
offset_status
This value specifies the on/off status for the display of element properties. This argument can be set to any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_offsets_set (p. 231) in the PCL Reference Manual Examples.
Main Index
306 PCL Reference Manual Display Menu
ga_display_parametric_get
(display_name, parametric_status)
Description: This function gets the on/off status for the display of parametric directions for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
parametric_status
This value returns the on/off status for the display of parametric directions. This argument can return any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_parametric_get (p. 232) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 307 Display Menu
ga_display_parametric_set
(display_name, parametric_status)
Description: This function will set the on/off status for the display of parametric directions for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
parametric_status
This values specifies the on/off status for the display of parametric directions.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_parametric_set (p. 234) in the PCL Reference Manual Examples.
Main Index
308 PCL Reference Manual Display Menu
ga_display_rename
(original_name, new_name)
Description: This function will rename the named display property list. Input: STRING
original_name[]
This value specifies the original name of the display property list.
STRING
new_name[]
This value specifies the new name of the display property list.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_rename (p. 235) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 309 Display Menu
ga_display_result_label_get
(display_name, result_label_status)
Description: This function will get the on/off status value for the named display property list that is used to control the display of results labels. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
result_label_status
This value returns the on/off status used to control the display of results labels. This argument can return any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_result_label_get (p. 236) in the PCL Reference Manual Examples.
Main Index
310 PCL Reference Manual Display Menu
ga_display_result_label_set
(display_name, result_label_status)
Description: This function is used to set the on/off status value for the named display property list that is used to control the display of results labels. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
result_label_status
This value specifies the status value that controls the display of results labels. This argument can be of any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_result_label_set (p. 237) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 311 Display Menu
ga_display_result_lblformat_get
(display_name, label_format)
Description: This function will get the format value of the result labels for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
STRING
label_format[31]
This value returns the result label format value which can be set to either “LETTER” or “VALUE”.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_result_lblformat_get (p. 239) in the PCL Reference Manual Examples.
Main Index
312 PCL Reference Manual Display Menu
ga_display_result_lblformat_set
(display_name, label_format)
Description: This function will set the format value of the results labels for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
label_format[31]
This value specifies the result label format. This argument can be set to a case insensitive value of either “LETTER”, or “VALUE”.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000092
The specified result label format is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_result_lblformat_set (p. 240) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 313 Display Menu
ga_display_showedges_get
(display_name, edges_status)
Description: This function will get the on/off status of the value used to control the display of edges for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
edges_status
This value returns the on/off status used to control the display of edges. This argument can be of any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_showedges_get (p. 241) in the PCL Reference Manual Examples.
Main Index
314 PCL Reference Manual Display Menu
ga_display_showedges_set
(display_name, edges_status)
Description: This function will set the on/off status of the value used to control the display of edges for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
edges_status
This value specifies the on/off status used to control the display of edges. This argument can be set to any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_showedges_set (p. 243) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 315 Display Menu
ga_display_shrfem_get
(display_name, shrink_factor)
Description: This function gets the shrink factor used in the display of finite elements for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
REAL
shrink_factor
This value returns the shrink factor.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_shrfem_get (p. 244) in the PCL Reference Manual Examples.
Main Index
316 PCL Reference Manual Display Menu
ga_display_shrfem_set
(display_name, shrink_factor)
Description: This function sets the shrink factor used in the display of finite elements for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
shrink_factor
This value specifies the shrink factor.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_shrfem_set (p. 245) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 317 Display Menu
ga_display_silhouette_get
(display_name, silhouette_status)
Description: This function will get the value used to turn the display of silhouettes on and off for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
silhouette_status
This value returns the value of used to control the display of silhouettes. This argument can return any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_silhouette_get (p. 247) in the PCL Reference Manual Examples.
Main Index
318 PCL Reference Manual Display Menu
ga_display_silhouette_set
(display_name, silhouette_status)
Description: This function will set the value used to turn the display of silhouettes on and off for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
silhouette_status
This value specifies the status value used control the display of silhouettes. This argument can be set to any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_silhouette_set (p. 248) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 319 Display Menu
ga_display_specular_get
(display_name, color_value)
Description: This function will get the value used to control the color used for the shading of specular reflections for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
color_value
This value returns the value used to control the color used for the shading of specular reflections. This argument can have a value of 1, for the color of the light, or 2, for the color of the object.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_specular_get (p. 250) in the PCL Reference Manual Examples.
Main Index
320 PCL Reference Manual Display Menu
ga_display_specular_set
(display_name, color_value)
Description: This function will set the value used to control the color used for the shading of specular reflections for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color used for the shading of specular reflections. This argument can be set to a value of 1, for the color of light, or 2, for the color of the object.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_specular_set (p. 251) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 321 Display Menu
ga_display_subdivision_get
(display_name, tolerance)
Description: This function will get the subdivision tolerance for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
REAL
tolerance
This value returns the subdivision tolerance.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_subdivision_get (p. 252) in the PCL Reference Manual Examples.
Main Index
322 PCL Reference Manual Display Menu
ga_display_subdivision_set
(display_name, tolerance)
Description: This function will set the subdivision tolerance for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
tolerance
This value specifies the subdivision tolerance value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_subdivision_set (p. 254) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 323 Display Menu
ga_display_texture_get
(display_name, texture_value)
Description: This function will get the texture value from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
REAL
texture_value
This value returns the texture value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_texture_get (p. 255) in the PCL Reference Manual Examples.
Main Index
324 PCL Reference Manual Display Menu
ga_display_texture_set
(display_name, texture_value)
Description: This function will set the texture value for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
texture_value
This value specifies the texture value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_texture_set (p. 257) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 325 Display Menu
ga_display_transparency_get
(display_name, transparency_value)
Description: This function will get the transparency level from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
REAL
transparency_value
This value returns the transparency level.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_transparency_get (p. 258) in the PCL Reference Manual Examples.
Main Index
326 PCL Reference Manual Display Menu
ga_display_transparency_set
(display_name, transparency_value)
Description: This function will set the transparency level for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
REAL
transparency_value
This value specifies the transparency value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_transparency_set (p. 259) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 327 Display Menu
ga_display_undeform_color_get
(display_name, color_value)
Description: This function will get the value of the color for undeformed entities from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
color_value
This value returns the color value for undeformed entities.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_undeform_color_get (p. 260) in the PCL Reference Manual Examples.
Main Index
328 PCL Reference Manual Display Menu
ga_display_undeform_color_set
(display_name, color_value)
Description: This function will set the value of the color for undeforned entities for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color used for the display of undeformed entities.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_undeform_color_set (p. 261) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 329 Display Menu
ga_display_undeform_get
(display_name, undeform_status)
Description: This function will get the on/off status of the value used to control the display of undeformed entities from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
undeform_status
This value returns the status value used to control the display of undeformed entities. This argument can return any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_undeform_get (p. 263) in the PCL Reference Manual Examples.
Main Index
330 PCL Reference Manual Display Menu
ga_display_undeform_set
(display_name, undeform_status)
Description: This function will set the on/off status of the value used to control the display of undeformed entities for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
undeform_status
This value specifies the on/off status used to control the display of undeformed entities. The argument can be set to any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_undeform_set (p. 264) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 331 Display Menu
ga_display_undeform_style_get
(display_name, curve_style)
Description: This function will get the value used to control the style used for the display of the lines that comprise undeformed entities from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
STRING
curve_style[31]
This value returns the style used to display the lines that comprise undeformed entities. This value will be set to either “SOLID”, or “DASHED”.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_undeform_style_get (p. 265) in the PCL Reference Manual Examples.
Main Index
332 PCL Reference Manual Display Menu
ga_display_undeform_style_set
(display_name, curve_style)
Description: This function will set the value used to control the style used for the display of the lines that comprise undeformed entities for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
curve_style[31]
This value specifies the style used to display the lines that comprise undeformed entities. The values allowed for this string are “SOLID”, or “DASHED”. This argument is not case sensitive.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000090
The specified undeformed entity style is not valid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_undeform_style_set (p. 266) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 333 Display Menu
ga_display_vector_color_get
(display_name, color_value)
Description: This function will get the value for the color used to plot vectors from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
color_value
This value returns the color used to plot vectors.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_color_get (p. 267) in the PCL Reference Manual Examples.
Main Index
334 PCL Reference Manual Display Menu
ga_display_vector_color_set
(display_name, color_value)
Description: This function will set the value of the color used to plot vectors for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value
This value specifies the color used to plot vectors.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_color_set (p. 269) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 335 Display Menu
ga_display_vector_colorstyl_get
(display_name, vector_style)
Description: This function will get the style used to plot vectors from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
STRING
vector_style[31]
This value returns the style used to plot vectors. This argument can return the values “VALUE”, “COMPONENT”, or “SPECTRUM”.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_colorstyl_get (p. 270) in the PCL Reference Manual Examples.
Main Index
336 PCL Reference Manual Display Menu
ga_display_vector_colorstyl_set
(display_name, vector_style)
Description: This function will set the style used to plot vectors for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
vector_style[31]
This value specifies the style used to plot vectors. This argument can a value of “VALUE”, “COMPONENT”, or “SPECTRUM”.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000094
Message 11000094 not found in message file(s).
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_colorstyl_set (p. 271) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 337 Display Menu
ga_display_vector_facolor_get
(display_name, color_value)
Description: This function will get the colors used to display functional assignment vectors from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
color_value(5)
This value returns the color values used to display functional assignment vectors.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_facolor_get (p. 272) in the PCL Reference Manual Examples.
Main Index
338 PCL Reference Manual Display Menu
ga_display_vector_facolor_set
(display_name, color_value)
Description: This function will set the values used to display functional assignment vectors for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
color_value(5)
This value specifies the color values used to display functional assignment vectors.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_facolor_set (p. 273) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 339 Display Menu
ga_display_vector_falabel_get
(display_name, label_status)
Description: This function will get the on/off status value used to control the display of labels for functional assignment vectors from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
label_status
This value returns the on/off status for the display of functional assignment vector labels. This argument can return any value.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_falabel_get (p. 274) in the PCL Reference Manual Examples.
Main Index
340 PCL Reference Manual Display Menu
ga_display_vector_falabel_set
(display_name, label_status)
Description: This function will set the on/off status value used to control the display of labels for functional assignment vectors for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
INTEGER
label_status
This value specifies the on/off status for the display of function assignment vector labels. This argument can be set to any value.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_falabel_set (p. 276) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 341 Display Menu
ga_display_vector_length_get
(display_name, vector_style)
Description: This function will get the value used to control the length style of plotted vectors from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
STRING
vector_style[31]
This value returns the vector length style. This argument will return the value “CONSTANT/SCREEN”, “SCALED/SCREEN”, “CONSTANT/MODEL”, or “SCALED/MODEL”.
INTEGER
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output:
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_length_get (p. 277) in the PCL Reference Manual Examples.
Main Index
342 PCL Reference Manual Display Menu
ga_display_vector_length_set
(display_name, vector_style)
Description: This function will set the value used to control the length style of plotted vectors for the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list to which the requested data value will be set.
STRING
vector_style[31]
This value specifies the vector length style. This argument can be set to the value “CONSTANT/SCREEN”, “SCALED_SCREEN”, “CONSTANT/MODEL”, or “SCALED/MODEL”. The value of this argument is not case sensitive.
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Output: INTEGER
Error Conditions: This is only a partial list of the error values that can be returned by this function. 11000042
The display property list is invalid.
11000094
Message 11000094 not found in message file(s).
11000098
A fatal error has occurred in the database. Database is corrupted.
11000107
The specified display property list was not found in the database.
13000004
Duplicate entry exists in table
13000007
An unspecified database error occurred
Remarks: None. Example: Please see ga_display_vector_length_set (p. 278) in the PCL Reference Manual Examples.
Main Index
Chapter 2: Basic Functions 343 Display Menu
ga_display_vector_reslabel_get
(display_name, label_status)
Description: This function will get the on/off status value used to control the display of labels on results vectors from the named display property list. Input: STRING
display_name[31]
This value specifies the name of the display property list from which the requested data value will be obtained.
INTEGER
label_status
This value returns the status value used to control the display of labels on results vectors. This argument can return any value.
INTEGER