CIP JavaScript documentation for class " pfcTableRetrieveInstructions"

Class pfcTableRetrieveInstructions

Description

This interface contains information needed to retrieve a table from disk.

See Also:: pfcTableOwner.RetrieveTable(), pfcTableOwner.RetrieveTableByOrigin()

Property Summary


`string`	`FileName`
	Name, excluding the extension.

`/* optional */ string`	`Path`
	Path to the table file, or `null`, if the file is in the working directory.

`pfcPoint3D`	`Position`
	The position for the retrieved table.

`/* optional */ pfcSimpRep`	`ReferenceRep`
	The simplified representation to use when copying data in the table. If `null`, the master representation of the reference solid will be used.

`/* optional */ pfcSolid`	`ReferenceSolid`
	The solid model from which to copy data into the table. If `null`, the table will not use any solid model data.

`/* optional */ number`	`Version`
	The file version, or `null`, for the latest file.

Method Summary


`static pfcTableRetrieveInstructions`	`Create (string FileName, pfcPoint3D Position)`
	Creates a data object containing instructions to retrieve a drawing table. Pass this function to `pfcTableOwner.RetrieveTable()`. or `pfcTableOwner.RetrieveTableByOrigin()`.

Property Detail

string FileName

Name, excluding the extension.

/* optional */ string Path

Path to the table file, or null, if the file is in the working directory.

pfcPoint3D Position

The position for the retrieved table.

/* optional */ pfcSimpRep ReferenceRep

The simplified representation to use when copying data in the table. If null, the master representation of the reference solid will be used.

/* optional */ pfcSolid ReferenceSolid

The solid model from which to copy data into the table. If null, the table will not use any solid model data.

/* optional */ number Version

The file version, or null, for the latest file.

Method Detail

static pfcTableRetrieveInstructions Create (string FileName, pfcPoint3D Position)

Creates a data object containing instructions to retrieve a drawing table.
Pass this function to pfcTableOwner.RetrieveTable(). or pfcTableOwner.RetrieveTableByOrigin().

Parameters:

FileName: The name of the table file.
Position: The location for the retrieved table.

Returns:: The created data object.