CIP JAVA documentation for class "com.ptc.pfc.pfcTable.TableRetrieveInstructions"

Interface TableRetrieveInstructions

package com.ptc.pfc.pfcTable; public interface TableRetrieveInstructions extends jxobject

Description

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

See Also:: TableOwner.RetrieveTable(TableRetrieveInstructions), TableOwner.RetrieveTableByOrigin(TableRetrieveInstructions)

Method Summary
`String`	`GetFileName ()` Get method for attribute "FileName" Name, excluding the extension.
`/optional/ String`	`GetPath ()` Get method for attribute "Path" Path to the table file, or `null`, if the file is in the working directory.
`Point3D`	`GetPosition ()` Get method for attribute "Position" The position for the retrieved table.
`/optional/ SimpRep`	`GetReferenceRep ()` Get method for attribute "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/ Solid`	`GetReferenceSolid ()` Get method for attribute "ReferenceSolid" The solid model from which to copy data into the table. If `null`, the table will not use any solid model data.
`/optional/ Integer`	`GetVersion ()` Get method for attribute "Version" The file version, or `null`, for the latest file.
`void`	`SetFileName (String value)` Set method for attribute "FileName" Name, excluding the extension.
`void`	`SetPath ( /optional/ String value)` Set method for attribute "Path" Path to the table file, or `null`, if the file is in the working directory.
`void`	`SetPosition (Point3D value)` Set method for attribute "Position" The position for the retrieved table.
`void`	`SetReferenceRep ( /optional/ SimpRep value)` Set method for attribute "ReferenceRep" The simplified representation to use when copying data in the table. If `null`, the master representation of the reference solid will be used.
`void`	`SetReferenceSolid ( /optional/ Solid value)` Set method for attribute "ReferenceSolid" The solid model from which to copy data into the table. If `null`, the table will not use any solid model data.
`void`	`SetVersion ( /optional/ Integer value)` Set method for attribute "Version" The file version, or `null`, for the latest file.

Method Detail

GetFileName/SetFileName

`String`	`GetFileName`	`()`
`void`	`SetFileName`	`(String value)`

Name, excluding the extension.

Manual References:: Drawings: Retrieving Drawing Tables, Drawings: Retrieving Drawing Tables

GetPath/SetPath

`/optional/ String`	`GetPath`	`()`
`void`	`SetPath`	`( /optional/ String value)`

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

Manual References:: Drawings: Retrieving Drawing Tables, Drawings: Retrieving Drawing Tables

GetVersion/SetVersion

`/optional/ Integer`	`GetVersion`	`()`
`void`	`SetVersion`	`( /optional/ Integer value)`

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

Manual References:: Drawings: Retrieving Drawing Tables, Drawings: Retrieving Drawing Tables

GetPosition/SetPosition

`Point3D`	`GetPosition`	`()`
`void`	`SetPosition`	`(Point3D value)`

The position for the retrieved table.

Manual References:: Drawings: Retrieving Drawing Tables, Drawings: Retrieving Drawing Tables

GetReferenceSolid/SetReferenceSolid

`/optional/ Solid`	`GetReferenceSolid`	`()`
`void`	`SetReferenceSolid`	`( /optional/ Solid value)`

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

Manual References:: Drawings: Retrieving Drawing Tables, Drawings: Retrieving Drawing Tables

GetReferenceRep/SetReferenceRep

`/optional/ SimpRep`	`GetReferenceRep`	`()`
`void`	`SetReferenceRep`	`( /optional/ SimpRep value)`

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

Manual References:: Drawings: Retrieving Drawing Tables, Drawings: Retrieving Drawing Tables