pw:: Database

Global actions for database entities

Derives From

pw::Object

Summary

pw:: Database	Global actions for database entities
Static Actions
getExportFileTypes	This action gets a list of file types that can export all of the given entities.
export	This action exports the list of entities to the given file.
import	Import the given file into the database.
save	This action saves the entire database in the native file format.
intersect	This action intersects database entities.
createSurfacesFromCurves	This action automatically creates new surfaces using the given curves as boundaries for Coons patches and trimmed planes.
getXYZ	This action gets the 3D position of the given point.
getEntity	This action gets the database entity of the given point.
offsetUV	This action offsets the uv coordinates of the given parametric database point.
offsetNormal	This action calculates the offset from the given database point in the direction of the normal at the point.
getNormal	This action returns the normal at the specified database point.
getTotalLength	This action gets the total length of a pw::Curve or boundary.
getCurve	This action gets the corresponding pw::Curve for a boundary, if any.
closestPoint	This action gets the closest point on a database entity from a given point.
intersectRay	This action gets the ray intersection on a database entity from a given ray.
isBaseForProject	This action checks if this database contains entities that can be projected onto using the project command.
getAll	This action gets a list of all database entities.
getCount	This action gets the number of entities in the database.
getByName	This action gets a database entity using the name.
getExtents	This action gets the extents of the database.
getSamePointTolerance	This action gets the same point tolerance for database operations.
getFitTolerance	This action gets the fit tolerance for database operations.
getAttributeDictionaryNames	This action gets a list of string names for the available attribute dictionaries attached to the given database entities or the database entities at the given point.
getAttributeDictionary	This action gets a dictionary of key-value pairs of attributes that have been attached to the given database entites or the database entities at the given point with the given dictionary name.
Static Attributes
ModelSize	This attribute is the model size of the database used to determine tolerances.
ImportVisibility	This attribute is the visiblity mode of database import.
ImportShellSplitAngle	This attribute is the bending angle that shell database entities are split at on import.
ImportShellCellMode	This attribute notifies how shell cells should be handled on import.
ImportAutoSplitSurfaces	This attribute notifies if the auto split should happen on import.

getExportFileTypes

pw::Database getExportFileTypes dbentity_list

This action gets a list of file types that can export all of the given entities.

Parameters

dbentity_list

This parameter is a list of pw::DatabaseEntity objects, or a single pw::DatabaseEntity object.

Returns

This action returns a list containing file type name strings that can be used in the export command.

export

pw::Database export ?-type file_type? ?-format file_format? ?-precision fp_precision? ?-noOverwrite? dbentity_list filename

This action exports the list of entities to the given file.

Parameters

-type file_type	This optional parameter is the string file type of the file with options < Automatic \| Gridgen \| IGES \| STL \| VRML \| PLOT3D \| Segment \| Patran \| Nastran \| UCD \| Xpatch \| NMB >.
-format file_format	This optional parameter is the string file format of the exported file with options < ASCII \| Binary \| Unformatted >.
-precision fp_precision	This optional parameter is the floating point precision string of the exported file with options < Double \| Single >. The default is Double.
-noOverwrite	This optional flag is the notification to not overwrite existing export files.
dbentity_list	This parameter is a list of pw::DatabaseEntity objects, or a single pw::DatabaseEntity object.
filename	This parameter is the string full path and name of the file to export.

Returns

This action returns nothing.

Information

This command supports progress updates.

File Types

Automatic	determine the file type based on the filename extension
Gridgen	Gridgen database file format
IGES	Initial Graphics Exchange Specification v5.3
STL	Stereo Lithography file format
VRML	VRML 1.0 format
VRML97	VRML 2.0/97 format
PLOT3D	3D, multi-grid format with kmax=1 and no i-blanking
Segment	Gridgen connector and line file format
Patran	Patran version 2.5 Neutral file format
Nastran	Nastran version 69 format, Double precision refers to “large” format real numbers (16 characters)
UCD	Advanced Visual Systems’ unstructured cell data file format
Xpatch	Xpatch unstructured data file format
NMB	GE data file format

For file_format A = ASCII, B = Binary, U = Unformatted

file_type     extension   file_format fp_precision     valid entity types
============= =========== =========== ================ =========================
Gridgen       dba         A           Double           any
IGES          igs,iges    A           Double           any except shells
STL           stl         A|B         Single           shells
VRML          wrl,vrml    A           Single           shells, bilinear surfaces
VRML97        wrl,vrml    A           Single           shells, bilinear surfaces
PLOT3D        x,xyz,p3d   A|B|U       Double|Single    bilinear surfaces
Segment       dat         A           Double|Single    linear curves
Patran        pat         A           Single*          shells, curves, surfaces
Nastran       nas         A           Double|Single**  shells, bilinear surfaces
UCD           ucd         A           Double|Single    shells
Xpatch        facet       A           Double|Single    shells
NMB           nmb         A|B         Double           any

*  The Patran format uses a fixed width field giving 10 digits of
   precision (single = 7 digits, double = 16 digits).
** The Nastran format uses a fixed width field giving 10 digits of
   precision (single = 7 digits, double = 16 digits), however the
   precision field is used to specify the style of Nastran export,
   where Single will generate the small NASTRAN format and Double
   will generate the large field NASTRAN-L format.

import

pw::Database import ?-type file_type? ?-format file_format? ?-precision fp_precision? ?-duplicates dup_mode? ?-report report_var? filename

Import the given file into the database.

Parameters

-type file_type	This optional parameter is the string file type of the file with options < Automatic \| Gridgen \| IGES \| STL \| VRML \| PLOT3D \| Network \|Segment \| Patran \| Nastran \| UCD \| Xpatch \| UGRID \| NMB \| NMBDirect \| CAD >. The default is Automatic.
-format file_format	This optional parameter is the string file format of the exported file with options < ASCII \| Binary \| Unformatted >. The default is ASCII.
-precision fp_precision	This optional parameter is the floating point precision string of the imported file with options < Double \| Single >. The default is Double.
-duplicates dup_mode	This optional parameter is the duplication mode for importing entities with existing names with options < Abort \| Skip \| Rename >. The default is Abort.
-report report_var	This optional parameter is a variable name to receive a string reporting the low-level details of the import.
filename	This parameter is the string full path and name of the file to import.

Returns

This action returns a list of the imported pw::DatabaseEntity objects.

Information

This command supports progress updates.

File Types

Automatic	determine the file type based on the filename extension
Gridgen	Gridgen database file format
IGES	Initial Graphics Exchange Specification v5.3
STL	Stereo Lithography file format
VRML	VRML 1.0 or 97 format
PLOT3D	3D, multi-grid format with kmax=1 and no i-blanking
Segment	Gridgen connector and line file format
Network	Gridgen structured grid and network surface file format
Patran	Patran version 2.5 Neutral file format
Nastran	Nastran version 69 format, Double precision refers to “large” format real numbers (16 characters)
UCD	Advanced Visual Systems’ unstructured cell data file format
Xpatch	Xpatch unstructured data file format
UGRID	2D/3D unstructured grid format
NMB	GE data file format
CAD	One of the supported Native CAD Reader file formats

Supported CAD Formats

ACIS Sat	Dassault Systems, Spatial ACIS SAT file format
CATIAV4	Dassault Systems CATIA V4 file format
CATIAV5	Dassault Systems CATIA V5 file format
Creo	PTC Creo file format (formally Pro/ENGINEER)
Parasolids	Siemens, Parasolid format
ProENGINEER	PTC Pro/ENGINEER format (now called Creo)
SOLIDWORKS	Dassault Systems, SOLIDWORKS file format
STEP	Standard for the Exchange of Product Model Data file format
NX	Siemens NX file format (formally Unigraphics)

For file_format A = ASCII, B = Binary, U = Unformatted

file_type     extension   file_format fp_precision     valid types
============= =========== =========== ================ ======================
Gridgen       dba         A           Double           any
IGES          igs,iges    A           Double           any
STL           stl         A|B         Single           shells
VRML          wrl,vrml    A           Single           shells
PLOT3D        x,xyz,p3d   A|B|U       Double|Single    bilinear surfaces
Network       grd,net     A|B|U       Double|Single    bilinear surfaces
Segment       dat         A           Double|Single    linear curves
Patran        pat         A           Single*          curves, surfaces
Nastran       nas         A           Double|Single**  shells
UCD           ucd         A           Double|Single    shells
Xpatch        facet       A           Double|Single    shells
UGRID         ugrid       A|B|U       Double|Single    shells
NMB           nmb         A|B         Double           any except notes
CAD           see CAD formats below...

CAD formats:
format        extension          file_format fp_precision     valid types
============= ================== =========== ================ ===============
ACIS Sat      sat                B           Double           any
CATIAV4       model              B           Double           any
CATIAV5       CATProduct,CATPart B           Double           any
Creo          asm,prt            B           Double           any
Parasolids    x_t,x_b            B           Double           any
ProENGINEER   asm,prt            B           Double           any
SOLIDWORKS    sldasm,sldprt      B           Double           any
STEP          stp,step           A           Double           any
NX            prt                B           Double           any

*  The Patran format uses a fixed width field giving 10 digits of
   precision (single = 7 digits, double = 16 digits)

** The Nastran format uses a fixed width field giving 10 digits of
   precision (single = 7 digits, double = 16 digits), however the
   precision field is used to specify the style of Nastran import,
   where Single will generate the small NASTRAN format and Double
   will generate the large field NASTRAN-L format.

Compatibility with DatabaseImporter mode

For backward compatability, the import defaults for this action are not the same as the defaults when using a DatabaseImporter mode. As you can see in the defaults listed below. All values are the same except for EntityVisibility and ShellCellMode.

DatabaseImporter attr      Default value          | Default value      pw::Database attr/param
-------------------------  ---------------------- | -----------------  -----------------------
EntityIgnoreIfNameUsed     false                  | false              -duplicates
EntityVisibility           ImportAndHideSupports  | Import             ImportVisibility
FileModelSizeFromFile      true                   | true               n/a
FileUnits                  FromFile               | FromFile           n/a
ModelFromFreeSurface       false                  | false              n/a
ModelAssembleTolerance     0                      | 0                  n/a
QuiltAssembleAngle         0                      | 0                  n/a
ShellCellMode              MergeCoplanar          | AsTriangles        ImportShellCellMode
ShellSplitAngle            0.0                    | 0.0                ImportShellSplitAngle
SurfaceSplitDiscontinuous  false                  | false              ImportAutoSplitSurfaces

To make shell import behavior the same, you can use <pw::Database setImportShellCellMode MergeCoplanar>.

However, due to the limited settings available for <pw::Database setImportVisibility>, you cannot make their behaviors match exactly. The value mapping is shown below. To set visibility behavior to ImportAndHideSupports or to gain access to the other mode attributes not available (n/a) using pw::Database, you must use a DatabaseImporter mode.

pw::Database       DatabaseImporter
ImportVisibility   EntityVisibility
----------------   ----------------------
true               Import
false              ShowAllAndHideSupports

save

pw::Database save ?-compress level? ?-noOverwrite? filename

This action saves the entire database in the native file format.

Parameters

-compress level	This optional parameter sets the integer file compression level with the range [0, 9]. The default is 0.
-noOverwrite	This optional flag is notification to not save if filename already exists.
filename	This parameter is the full path and name string of the file to save.

Returns

This action returns nothing.

Information

This command supports progress updates.

For “-compress level”, 0 = no compression, 1 = minimum, and 9 = maximum. Higher levels of compression take longer to save.

intersect

pw::Database intersect ?-tolerance tol? ?-actual do_actual? ?-apparent line_of_sight? ?-closest max_dist? dbentity_list1 ?dbentity_list2?

This action intersects database entities.

Parameters

-tolerance tol	This optional flag is the float same point tolerance used during intersection calculation with the range [0, infinity). The default is same point tolerance.
-actual do_actual	This optional flag is the boolean parameter for whether actual intersection should be done. The default is true.
-apparent line_of_sight	This optional parameter is the line of sight vector for apparent intersections of curves, which will only be included if this argument is present.
-closest max_dist	This optional parameter is the float maximum distance for closest point “intersections” of curves, which will only be included if this argument is present with the range [0, infinity), where 0 is no limit.
dbentity_list1	This parameter is a list of pw::DatabaseEntity objects, or a single pw::DatabaseEntity object.
dbentity_list2	This parameter is a list of pw::DatabaseEntity objects, or a single pw::DatabaseEntity object.

Returns

This action returns a list of the newly created pw::DatabaseEntity objects.

Information

If only dbentity_list1 is specified, the entities in this list are intersected with themselves.

If both dbentity_list1 and dbentity_list2 are specified, the entities in dbentity_list1 are intersected with the entities in dbentity_list2.

This command supports progress updates.

createSurfacesFromCurves

pw::Database createSurfacesFromCurves ?-tolerance tol? curves

This action automatically creates new surfaces using the given curves as boundaries for Coons patches and trimmed planes. If the curve boundaries selected for a patch are coplanar, a trimmed plane will be constructed instead of a Coons patch.

Parameters

-tolerance tol	This optional parameter is the fit tolerance; if this flag is not present the current fit tolerance is used.
curves	This parameter is a list of pw::Curve objects and/or boundaries.

Returns

This action returns a list of new pw::DatabaseEntity objects, which may include pw::Surface and pw::Quilt objects. Note that when creating a trimmed plane, several new entities will be created, but only the quilt will be returned.

getXYZ

pw::Database getXYZ point

This action gets the 3D position of the given point.

Parameters

point

This parameter is a point.

Returns

This action returns an xyz vector.

getEntity

pw::Database getEntity point

This action gets the database entity of the given point.

Parameters

point

This parameter is a point.

Returns

This action returns a pw::DatabaseEntity object.

Information

If the given point is not database constrained, an error will occur.

offsetUV

pw::Database offsetUV point < u | uv >

This action offsets the uv coordinates of the given parametric database point.

Parameters

point	This parameter is a point in the form “u v dbentity”.
u	This parameter is the float u amount to offset.
uv	This parameter is the vector uv amount to offset.

Returns

This action returns a point in the form “u v dbentity”.

Information

If the given point is not parametric database constrained, an error will occur.

offsetNormal

pw::Database offsetNormal point distance

This action calculates the offset from the given database point in the direction of the normal at the point.

Parameters

point	This parameter is a point.
distance	This parameter is the float distance to offset.

Returns

This action returns an xyz vector.

Information

If the given point is not database constrained, or the normal is not defined for the database entity, an error will occur.

getNormal

pw::Database getNormal point

This action returns the normal at the specified database point.

Parameters

point

This parameter is a point.

Returns

This action returns an xyz vector.

Information

If the given point is not database constrained, or the normal is not defined for the database entity, an error will occur.

getTotalLength

pw::Database getTotalLength < curve | boundary >

This action gets the total length of a pw::Curve or boundary.

Parameters

curve	This parameter is the pw::Curve object to get the total length of.
boundary	This parameter is the boundary to get the total length of.

Returns

This action returns the float length which has the range [0.0, infinity).

getCurve

pw::Database getCurve boundary

This action gets the corresponding pw::Curve for a boundary, if any.

Parameters

boundary

This parameter is the boundary for which the corresponding pw::Curve will be returned, if one exists.

Returns

The pw::Curve corresponding to a boundary. If no pw::Curve exists, an error will be raised.

closestPoint

pw::Database closestPoint ?-parametric? ?-projection? ?-explicit ents? ?-state stateVar? point ?dir?

This action gets the closest point on a database entity from a given point.

Parameters

-parametric	This optional flag is the notification to restrict the closest point found to be on a curve, surface, trimmed surface, or quilt. This option can be combined with -projection.
-projection	This optional flag is the notification to restrict the closest point found to be on an entity that other entities can be projected onto, such as a surface, trimmed surface, quilt or shell. This option can be combined with -parametric.
-explicit ents	This optional parameter restricts the closest point found to be on the given entities in the list of pw::DatabaseEntity objects. If given, the -parametic and -projection flags will be ignored.
-state stateVar	This optional parameter will indicate on return if a surface was found (true) or not (false).
point	This parameter is the point that is projected onto the current database entities.
dir	This parameter is a direction vector for finding the closest point from a ray.

Returns

This action returns a point, in the parameter space of the closest database entity, if there is no closest point this action will return the given point. Also, if -state stateVar is used, stateVar indicates whether a surface was found or not.

intersectRay

pw::Database intersectRay ?-parametric? ?-projection? ?-explicit ents? ?-state stateVar? point dir

This action gets the ray intersection on a database entity from a given ray. This function ignores all non-surface entities like curves or points.

Parameters

-parametric	This optional flag is the notification to restrict the closest point found to be on a surface, trimmed surface, or quilt. This option can be combined with -projection.
-projection	This optional flag is the notification to restrict the closest point found to be on an entity that other entities can be projected onto, such as a surface, trimmed surface, quilt or shell. This option can be combined with -parametric.
-explicit ents	This optional parameter restricts the intersection found to be on the given entities in the list of pw::DatabaseEntity objects. If given, the -parametic and -projection flags will be ignored.
-state stateVar	This optional parameter will indicate on return if a surface was found (true) or not (false).
point	This parameter is the point that is the start of the ray.
dir	This parameter is a direction vector for the ray.

Returns

This action returns a point, in the parameter space of the intersected database entity, if there is no intersection point this action will return the given point. Also, if -state stateVar is used, stateVar indicates whether a surface was found or not.

isBaseForProject

pw::Database isBaseForProject

This action checks if this database contains entities that can be projected onto using the project command.

Parameters

This action has no parameters.

Returns

This action returns boolean, true if the database contains entities that can be projected onto.

getAll

pw::Database getAll ?-framework framework? ?-type type_string?

This action gets a list of all database entities.

Parameters

-framework	If specified, this argument specifies which pw::Framework to query. If not specified, the active pw::Framework is used as the target.
-type type_string	If specified, this option filters the result to include only entities of the specified type. Only types derived from pw::DatabaseEntity are valid.

Returns

This action returns a list of pw::DatabaseEntity objects.

getCount

pw::Database getCount ?-framework framework? ?-type type_string?

This action gets the number of entities in the database.

Parameters

-framework

If specified, this argument specifies which pw::Framework to query. If not specified, the active pw::Framework is used as the target. -type type_string If specified, this option filters the result to include only entities of the specified type. Only types derived from pw::DatabaseEntity are valid.

Returns

This action returns an integer value.

getByName

pw::Database getByName ?-path path? name

This action gets a database entity using the name.

Parameters

name	This parameter is a name string.
-path path	This parameter and its argument specify the path to the framework in which the database entity resides. The path argument must be a list of either pw::Framework objects or framework names. The path must start at the root framework, start at the active framework, or start at a child of the active framework. The active framework is used as the default if this parameter is not specified.

Returns

This action returns a pw::DatabaseEntity object.

getExtents

pw::Database getExtents ?-enabledOnly? ?-visibleOnly?

This action gets the extents of the database.

Parameters

-enabledOnly	This flag, if present, restricts the calculations to only enabled entities, regardless of their visibility. Enabled entities in off layers are included, for example.
-visibleOnly	This flag, if present, restricts the calculations to only visible entities.

Returns

This action returns a list of two vectors representing the min and max xyz points of the extents.

getSamePointTolerance

pw::Database getSamePointTolerance

This action gets the same point tolerance for database operations.

Parameters

This action has no parameters.

Returns

This action returns the float tolerance.

getFitTolerance

pw::Database getFitTolerance

This action gets the fit tolerance for database operations.

Parameters

This action has no parameters.

Returns

This action returns the float tolerance.

getAttributeDictionaryNames

pw::Database getAttributeDictionaryNames ?-children? < dbentity_list | point >

This action gets a list of string names for the available attribute dictionaries attached to the given database entities or the database entities at the given point.

Parameters

-children	This optional flag is the notification to include names of attribute dictionaries attached to children of the database entities as well.
dbentity_list	This parameter is a list of pw::DatabaseEntity objects, or a single pw::DatabaseEntity object.
point	This parameter is a point.

Returns

This action returns a list of strings.

Information

If the given point is not database constrained, an error will occur.

getAttributeDictionary

pw::Database getAttributeDictionary ?-children? < dbentity_list | point > dict_name ?attr_names?

This action gets a dictionary of key-value pairs of attributes that have been attached to the given database entites or the database entities at the given point with the given dictionary name.

Parameters

-children	This optional flag is the notification to include the attribute dictionary attached to children of the database entities as well.
dbentity_list	This parameter is a list of pw::DatabaseEntity objects, or a single pw::DatabaseEntity object.
point	This parameter is a point.
dict_name	This parameter is the string name of the dictionary.
attr_names	This optional parameter is a string name or a list of string names to limit the attributes which should be returned by this action. If not specified, all existing attributes will be returned by this action.

Returns

This action returns a list of strings that can be converted into a tcl dictionary (list of alternating keys and values).

Information

If the given point is not database constrained, an error will occur. When using the -children flag, the dictionary will be a combination of values from multiple dictionaries from different entities, but only the first value found while traversing the children is retained.

pw:: Database

Derives From

Static Actions

getExportFileTypes

Parameters

Returns

export

Parameters

Returns

Information

File Types

import

Parameters

Returns

Information

File Types

Supported CAD Formats

Compatibility with DatabaseImporter mode

save

Parameters

Returns

Information

intersect

Parameters

Returns

Information

createSurfacesFromCurves

Parameters

Returns

See Also

getXYZ

Parameters

Returns

getEntity

Parameters

Returns

Information

offsetUV

Parameters

Returns

Information

offsetNormal

Parameters

Returns

Information

getNormal

Parameters

Returns

Information

getTotalLength

Parameters

Returns

getCurve

Parameters

Returns

closestPoint

Parameters

Returns

intersectRay

Parameters

Returns

isBaseForProject

Parameters

Returns

getAll

Parameters

Returns

getCount

Parameters

Returns

getByName

Parameters

Returns

getExtents

Parameters

Returns

getSamePointTolerance

Parameters

Returns

getFitTolerance