CIP C++ documentation for class "pfcTableRetrieveInstructions"

Class pfcTableRetrieveInstructions

# include <pfcTable.h> class pfcTableRetrieveInstructions : public virtual xobject { xdeclare(pfcTableRetrieveInstructions) ... }; This is a COMPACT class.

Description

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

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

Manual References:: Drawings: Retrieving Drawing Tables

Method Summary


`static pfcTableRetrieveInstructions_ptr`	`Create (xrstring FileName, pfcPoint3D_ptr Position)`
	Creates a data object containing instructions to retrieve a drawing table. Pass this function to `pfcTableOwner::RetrieveTable(pfcTableRetrieveInstructions_ptr)`. or `pfcTableOwner::RetrieveTableByOrigin(pfcTableRetrieveInstructions_ptr)`.

`xstring`	`GetFileName ()`
`void`	`SetFileName (xrstring value)`
	Name, excluding the extension.

`optional xstring`	`GetPath ()`
`void`	`SetPath (optional xrstring value)`
	Path to the table file, or `null`, if the file is in the working directory.

`pfcPoint3D_ptr`	`GetPosition ()`
`void`	`SetPosition (pfcPoint3D_ptr value)`
	The position for the retrieved table.

`optional pfcSimpRep_ptr`	`GetReferenceRep ()`
`void`	`SetReferenceRep (optional pfcSimpRep_ptr value)`
	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_ptr`	`GetReferenceSolid ()`
`void`	`SetReferenceSolid (optional pfcSolid_ptr value)`
	The solid model from which to copy data into the table. If `null`, the table will not use any solid model data.

`optional xint`	`GetVersion ()`
`void`	`SetVersion (optional xint value)`
	The file version, or `null`, for the latest file.

Method Detail

`xstring`	`GetFileName`	`()`
`void`	`SetFileName`	`(xrstring value)`

Name, excluding the extension.

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

`optional xstring`	`GetPath`	`()`
`void`	`SetPath`	`(optional xrstring 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

`optional xint`	`GetVersion`	`()`
`void`	`SetVersion`	`(optional xint value)`

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

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

`pfcPoint3D_ptr`	`GetPosition`	`()`
`void`	`SetPosition`	`(pfcPoint3D_ptr value)`

The position for the retrieved table.

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

`optional pfcSolid_ptr`	`GetReferenceSolid`	`()`
`void`	`SetReferenceSolid`	`(optional pfcSolid_ptr 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

`optional pfcSimpRep_ptr`	`GetReferenceRep`	`()`
`void`	`SetReferenceRep`	`(optional pfcSimpRep_ptr 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

static pfcTableRetrieveInstructions_ptr Create (xrstring FileName, pfcPoint3D_ptr Position)

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

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

Parameters:

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

Returns:: The created data object.