Skip to end of metadata
Go to start of metadata

Description

This object holds information about scheduled and actual start and end times, and provides links for the associated Operations Schedule, Operations Request, Request Segment and Operations Response objects.

This object is one of the few objects that is not derived from the MESAbstractObject and therefore does not inherit its functions or properties.



Object Creation

This object is created whenever an MES Work Order table entry is dropped onto the MES Schedule View component or a schedule entry is created by right-clicking on the MES Schedule View component.


Use

This object is passed by the userMenuItemClicked event handler for MES Schedule View component. The following scripting functions also return this type of object as part of the MESObjectList:



MES Schedule View component



Object Functions

This object provides the following functions:

 getActualEndDate()
Description

Returns the DateTime that the operation actually ended. This property will read back as "None" until the operation actually ends.

Syntax

getActualEndDate()


  • Parameters

None

  • Returns

Date actualEndDate - The DateTime that the operation actually ended. "None" until the operation has actually ended.

  • Scope

All

 getActualStartDate()
Description

Returns the DateTime that the operation actually began. This property will read back as "None" until the operation actually begins.

Syntax

getActualStartDate()


  • Parameters

None

  • Returns

Date actualStartDate - The DateTime that the operation actually began. "None" until the operation has actually begun.

  • Scope

All

 getCategory()
Description

Gets the category of this schedule entry.

Syntax

getCategory()


  • Parameters

None

  • Returns

String category - The category of this schedule entry. Active and Actual are reserved for currently active and completed respectively. Custom categories are also acceptable.

  • Scope

All

 getDefaultToolTipText()
Description

Returns the tool tip text with details of schedule start, end and progress.

Syntax

getDefaultToolTipText()


  • Parameters

None

  • Returns

The tool tip text for this schedule entry.

  • Scope

All

 getLabel()
Description

Gets the label for this schedule.

Syntax

getLabel()


  • Parameters

None

  • Returns

String label - The label corresponding to this schedule entry.

  • Scope

All

 getMESOperationsRequestLink()
Description

Returns the link to this operations request object.

Syntax

getMESOperationsRequestLink()


  • Parameters

None

  • Returns

MESObjectLink mesOperationsRequestLink - The link to the operations request object.

  • Scope

All

 getMESOperationsResponseLink()
Description

Returns the MES link to the operations response object.

Syntax

getMESOperationsResponseLink()


  • Parameters

None

  • Returns

MESObjectLink mesOperationsResponseLink - The link corresponding to operations response object.

  • Scope

All

 getMESOperationsScheduleLink()
Description

Returns the MES object link to the operations schedule object.

Syntax

getMESOperationsScheduleLink()


  • Parameters

None

  • Returns

MESObjectLink - The link to the operations schedule object.

  • Scope

All

 getOriginalEndDate()
Description

Returns the DateTime that the operation was originally scheduled to end. This does not change, regardless of later changes to the operation's schedule or when it actually ended.

Syntax

getOriginalEndDate()


  • Parameters

None

  • Returns

Date originalEndDate - The DateTime that the operation was originally scheduled to end. Retains the same DateTime value, regardless of scheduling changes to the operation prior or during the run.

  • Scope

All

 getOriginalStartDate()
Description

Returns the DateTime that the operation was originally scheduled to begin (start). This does not change, regardless of later changes to the operation's schedule or when it actually began (started).

Syntax

getOriginalStartDate()


  • Parameters

None

  • Returns

Date originalStartDate - The DateTime that the operation was originally scheduled to begin (start). Retains the same DateTime value, regardless of scheduling changes to the operation prior or during the run.

  • Scope

All

 getOriginalState()
Description

Returns the original state of this schedule entry.

Syntax

getOriginalState()


  • Parameters

None

  • Returns

Integer originalState - The state at which the schedule started.

  • Scope

All

 getProgressPercent()
Description

Gets the progress of work done in percentage for this schedule.

Syntax

getProgressPercent()


  • Parameters

None

  • Returns

double progressPercent - The percentage of work done for this schedule entry.

  • Scope

All

 getScheduledEndDate()
Description

Returns the currently-scheduled end DateTime, taking into account automatic delays by the system. This DateTime changes minute by minute if the current time causes the schedule to be pushed out.

Syntax

getScheduledEndDate()


  • Parameters

None

  • Returns

Date scheduledEndDate - The currently-scheduled end DateTime, taking into account automatic delays by the system.

  • Scope

All

 getScheduledStartDate()
Description

Returns the currently-scheduled begin (start) DateTime, taking into account automatic delays by the system. This DateTime changes minute by minute if the current time causes the schedule to be pushed out.

Syntax

getScheduledStartDate()


  • Parameters

None

  • Returns

Date scheduledStartDate - The currently-scheduled begin (start) DateTime, taking into account automatic delays by the system.

  • Scope

All

 getState()
Description

Gets the integer corresponding to state of this schedule entry. The corresponding integer values for each state are as follows:

StateState NameDescription
0Selected in editing modeThe schedule entry has been selected (clicked on) by the user.
1Auto IncompleteThe schedule entry is in Auto mode (set to start automatically) but has not yet started.
2Auto RunningThe schedule entry is in Auto mode (set to start automatically) and is currently running.
3Auto CompleteThe schedule entry is in Auto mode (set to start automatically) and has completed.
4Manual IncompleteThe schedule entry is in Manual mode but has not yet started
5Manual RunningThe schedule entry is in Manual mode and is currently running.
6Manual CompleteThe schedule entry is in Manual mode and has completed.
7FaultedThe schedule entry is faulted.
Syntax

getState()


  • Parameters

None

  • Returns

Integer state - The state of this schedule entry.

  • Scope

All

 getStateAsString()
Description

Gets the state of this schedule entry. The possible states are as follows:

Auto States

  • Auto - Incomplete
  • Active
  • Complete

Manual States

  • Manual - Incomplete
  • Active
  • Complete

General States

  • Selected
  • Faulted
Syntax

getStateAsString()


  • Parameters

None

  • Returns

String state - The state of this schedule entry.

  • Scope

All

 getUserScheduledEndDate()
Description

Returns the end DateTime most recently scheduled by the user. This is the latest schedule the user has set for the operation via script or by dragging in the Schedule View component. This DateTime does not change when the system pushes the schedule out automatically.

Syntax

getUserScheduledEndDate()


  • Parameters

None

  • Returns

Date userScheduledEndDate - The end DateTime most recently scheduled by the user via script or by dragging in the Schedule View component. Doesn't change when system automatically pushes schedule out.

  • Scope

All

 getUserScheduledStartDate()
Description

Returns the begin (start) DateTime most recently scheduled by the user. This is the latest schedule the user has set for the operation via script or by dragging in the Schedule View component. This DateTime does not change when the system pushes the schedule out automatically.

Syntax

getUserScheduledStartDate()


  • Parameters

None

  • Returns

Date userScheduledStartDate - The begin (start) DateTime most recently scheduled by the user via script or by dragging in the Schedule View component. Doesn't change when system automatically pushes schedule out.

  • Scope

All

 getWorkOrderLink()
Description

Get the reference to MES Work Order object.

Syntax

getWorkOrderLink()


  • Parameters

None

  • Returns

MESObjectLink workOrderLink - The object link that represents the MES Work Order object.

  • Scope

All

 hasMESOperationsRequestLink()
Description

Checks the existence of an MES link to the OperationsRequest object.

Syntax

hasMESOperationsRequestLink()


  • Parameters

None

  • Returns

boolean mesOperationsRequestLink - True, if there is any link corresponding to OperationsRequest object and False otherwise.

  • Scope

All

 hasMESOperationsResponseLink()
Description

Checks the existence of an MES link to the operations response object.

Syntax

hasMESOperationsResponseLink()


  • Parameters

None

  • Returns

boolean mesOperationsResponseLink - True, if there is any link corresponding to operations response object and False otherwise.

  • Scope

All

 hasMESOperationsScheduleLink()
Description

Checks for any MES object link to the operations schedule object.

Syntax

hasMESOperationsScheduleLink()


  • Parameters

None

  • Returns

boolean - True, If there exist an MES object link for the operations schedule and False otherwise.

  • Scope

All

 hasState()
Description

Checks if there is any state defined for this schedule entry.

Syntax

hasState()


  • Parameters

None

  • Returns

boolean state - True if there is any state associated with this schedule entry and False otherwise.

  • Scope

All

  • No labels