CIP C++ documentation for class "pfcCableParamsImportInstructions"

Class pfcCableParamsImportInstructions

# include <pfcModel.h> class pfcCableParamsImportInstructions : public virtual pfcImportInstructions { xdeclare(pfcCableParamsImportInstructions) ... }; This is a COMPACT class.

Description

This class specifies instructions used to import from a cable parameters file.

Manual References:: Interface: Import Instructions

Method Summary


`static pfcCableParamsImportInstructions_ptr`	`Create (pfcModel_ptr Harness, xrstring CableName)`
	Creates a new instructions object used to import from cable parameters (CABLE_PARAMS) type file.

`xstring`	`GetCableName ()`
`void`	`SetCableName (xrstring value)`
	The name of the imported cable file.

`pfcModel_ptr`	`GetHarness ()`
`void`	`SetHarness (pfcModel_ptr value)`
	A harness model referenced by the assembly.

Methods Inherited from Class pfcImportInstructions:: GetFileType

Method Detail

`pfcModel_ptr`	`GetHarness`	`()`
`void`	`SetHarness`	`(pfcModel_ptr value)`

A harness model referenced by the assembly.

`xstring`	`GetCableName`	`()`
`void`	`SetCableName`	`(xrstring value)`

The name of the imported cable file.

static pfcCableParamsImportInstructions_ptr Create (pfcModel_ptr Harness, xrstring CableName)

Creates a new instructions object used to import from cable parameters (CABLE_PARAMS) type file.

This argument must be passed to pfcModel::Import(xrstring, pfcImportInstructions_ptr) to read in the parameters file. Valid only for cabling assemblies.

Manual References:: Interface: Import Instructions

Parameters:

Harness: A harness referenced by the assembly.
CableName: The name of the imported cable file.

Returns:: The new instructions object.