AttachPortsCommand Object


Description:

Connects to the chassis, then reserves and maps the ports. Uses the location defined in the specified Port objects to connect to the chassis and reserve the ports, after which it creates the mapping between the physical ports and their logical representation in the test configuration. You can use AttachPortsCommand in place of performing these operations separately (by using the connect and reserve functions along with the MapPorts command).

Can be used with Command Sequencer: No

Parents: Sequencer, StcSystem

AttachPortsCommand Writable Attributes

Attribute Description
Common Writable Attributes ProgressCancelled
AutoConnect

Connect to each port's chassis if not already connected.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Connect to each port's chassis.

FALSE

Do not connect to each port's chassis.

ContinueOnFailure

In the case that attaching a port fails, continue on with other ports in the list.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Continue when attaching a port fails.

FALSE

Stop and return error when attaching a port fails.

PortList

List of one or more ports to reserve and map.

Type: handle

Default: 0

RevokeOwner

Whether to kick off the current owners of the ports and reserve the ports.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Kick off current owners.

FALSE

Reserve only if the ports are available.

AttachPortsCommand Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes ElapsedTime, EndTime, ProgressCurrentStep, ProgressCurrentStepName, ProgressCurrentValue, ProgressDisplayCounter, ProgressMaxValue, ProgressStepsCount, StartTime, State, Status