CIP Visual Basic.NET documentation for interface "IpfcTableRetrieveInstructions"

Interface IpfcTableRetrieveInstructions

Description

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

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

Property Summary


`Property`	`FileName`	`as String`
	Name, excluding the extension.

`Property`	`Path`	`as String [optional]`
	Path to the table file, or `null`, if the file is in the working directory.

`Property`	`Position`	`as IpfcPoint3D`
	The position for the retrieved table.

`Property`	`ReferenceRep`	`as IpfcSimpRep [optional]`
	The simplified representation to use when copying data in the table. If `null`, the master representation of the reference solid will be used.

`Property`	`ReferenceSolid`	`as IpfcSolid [optional]`
	The solid model from which to copy data into the table. If `null`, the table will not use any solid model data.

`Property`	`Version`	`as Long [optional]`
	The file version, or `null`, for the latest file.

Method Summary


`Function`	`CCpfcTableRetrieveInstructions.Create (FileName as String, Position as IpfcPoint3D) as IpfcTableRetrieveInstructions`
	Creates a data object containing instructions to retrieve a drawing table. Pass this function to `IpfcTableOwner.RetrieveTable()`. or `IpfcTableOwner.RetrieveTableByOrigin()`.

Property Detail

Property FileName as String

Name, excluding the extension.

Property Path as String [optional]

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

Property Position as IpfcPoint3D

The position for the retrieved table.

Property ReferenceRep as IpfcSimpRep [optional]

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

Property ReferenceSolid as IpfcSolid [optional]

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

Property Version as Long [optional]

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

Method Detail

Function CCpfcTableRetrieveInstructions.Create (FileName as String, Position as IpfcPoint3D) as IpfcTableRetrieveInstructions

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

Parameters:

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

Returns:: The created data object.