Overwrite calendar Class


( Calendar which can be dynamically modified on charts. )

<ASBOCalendar> Interface

 

Property Overview

TabProperty NameData TypeDescription

General

Resource
(OCal_Resource)

<Multi>
<Basic><Standard>
Resource
<ASBResource> Data Type

Object

Specify here the resource whose working time you what to overwrite. it can be set with resource groups or more than one resources.

 

Start time
(OCal_StartTime)

<Basic><Standard>

Time

The starting time of the overwrite calendar. This is linked to the first value in the [Time series] property. For modifying resource quantity midway, please change the [Time series] property instead.

 

End time
(OCal_EndTime)

<Basic><Standard>

Time

The ending time of the overwrite calendar. This is linked to the last value in the [Time series] property. For modifying resource quantity midway, please change the [Time series] property instead.

 

Sort order
(OCal_SortOrder)

<Basic><Standard>
SortOrder
<double> Data Type

Float

When there are more than one overwrite calendar entries at the same time on the same resource, the one with the largest [Sort order] will be chosen. However, if [Time stamp] are not the same, the newer one will be chosen regardless of [Sort order]. Because the newly imported record's [Time stamp] will be the same, the [Sort order] will be used in this situation. It will not be compared with [Sort order] in the Calendar table.

 

Time stamp
(OCal_TimeStamp)

<Basic><Standard>
TimeStamp
<DATE> Data Type

Time

The time when the overwrite calendar entry was added via the GUI. When the entry was imported but the [Time stamp] was empty, it was the time when executed importing. If several entries exist for the same time, the newest one is chosen. If the [Time stamp] is still idential the [Sort order] is applied.

 

Color
(OCal_Color)

<Basic><Standard>
Color
<LONG> Data Type

Color

Color of this object. Used when displayed in the Resource Gantt chart.

 

Display text
(OCal_DisplayText)

<Multi>
<Basic><Standard>
Comment
<BSTR> Data Type

String

The bottom display text of the overwrite calendar.

 

Disabled flag
(OCal_Disabled)

<Basic><Standard>
Disabled
<VARIANT_BOOL> Data Type

Enum

Specify here whether to use this overwrite calendar entry or not.


ValueNameDescription
0NoThis overwrite calendar entry will be used.
1YesThis overwrite calendar entry will be ignored.

 

Time series
(OCal_TimeSeries)

<Multi>
<Basic><Standard>
TimeSeries
<DATE> Data Type

Time

The time stamp of overwrite calendar entry. Please set the start and end times. If the resource quantity changes along with time, please also set the [Resource quantity] property. Thus, the count of [Time series] should always 1 larger than [Resource quantity]. For example, if wanted to set On Oct 1st, 2018, resource quantity is 1 during 0-1, while resource quantity is 2 during 1-2, you can set the [Time series] to 2018/10/1 00:00:00;2018/10/1 01:00:00;2018/10/1 02:00:00 and [Resource quantity] to 1;2. ENU

 

Resource quantity
(OCal_ResQty)

<Multi>
<Basic><Standard>
ResQty
<double> Data Type

Float

Resource quantity of overwrite calendar entry. If the resource quantity changes along with time, please set them in this property, then set the correspoding [Time series]. Thus, the count of [Time series] should always 1 larger than [Resource quantity]. For example, if wanted to set On Oct 1st, 2018, resource quantity is 1 during 0-1, while resource quantity is 2 during 1-2, you can set the [Time series] to 2018/10/1 00:00:00;2018/10/1 01:00:00;2018/10/1 02:00:00 and [Resource quantity] to 1;2. ENU

Link

Label
(OCal_Label)

<RO> <Multi>
<Standard>

Object

This is the label for the overwrite calendar.

Common

Code
(Code)

<Basic><Standard>

String

Name of the object used internally. The code does not need to be unique including objects such as order. In that case, however, other property should be added to the DBIO primary key for a merge process during import and synchronization. Also, in cases where orders are specified by code such as for next orders, behavior is undefined.

 

Display name
(DisplayString)

<Standard>

String

Display name held internally in Asprova. If a value is set here, the display name will be displayed in place of the code. Starting with Ver4, single quotations (') are not allowed.

 

Alias
(DisplayAlias)

<Standard>

String

Specify here an alias of the object. If a value is set here, the alias will be displayed in place of its code or display name.
To display an alias, you need to select User defined aliases from [Workspace] - [General] - [String display method] (The default is set to this value). Starting with Ver4, single quotations (') are not allowed.

 

Comments (common)
(Comment)

<Multi>
<Standard>

String

Enter comments here. This property is common to each class and you can use it for Properties to be copied to operation from order of the Project class and so on.

 

Object ID
(ObjectID)

<RO>
<Standard>

Unsigned integer

ID number defined by each object.

 

Parent
(Parent)

<RO>
<Standard>

Object

The object at one level higher than this object.

 

Children
(Child)

<RO> <Multi>
<Standard>

Object

Objects at one level lower than this object.

 

Class definition
(Object_ClassDef)

<RO>
<Standard>

Object

Object that defines the class information of this object.

 

Internal status flag
(Object_StatusFlag)

<RO>
<Standard>

Enum

Represents the status such as whether the object was added or changed within Asprova.


ValueNameDescription
 NoneThis record has not been changed.
ANewly addedThis record has been newly added.
MModifiedThis record has been modified.
DDeletedThis record has been deleted.

 

Status flag
(Object_StatusFlagExt)

<RO>
<Standard>

Enum

Represents the status such as whether the object was added or changed outside Asprova.


ValueNameDescription
 NoneThis record has not been changed externally.
ANewly addedThis record has been newly added externally.
MModifiedThis record has been modified externally.
DDeletedThis record has been deleted externally.

 

Invalid flag
(Object_InvalidFlag)

<RO>
<Standard>

Bool

Indicates whether the object is invalid or not.

 

Reason to be invalidated
(ReasonToBeInvalidated)

<RO> <Multi>
<Standard>

Enum

Reason why the invalid flag is on.


ValueNameDescription
NNo valid master for order explosionNo valid master exists when orders are exploded.
LBMaster loop (master object)Master object in which a loop was detected.
LNMaster loop (master input instruction)Master input instruction in which a loop was detected.
LIMaster loop (item)Item in which a loop was detected.
FOrder explosion failureOrder explosion failed at last execution.
LIntegrated master loopItem that is detected to have a loop in the integrated master, and it's auto replenishment flag is not No.
GFailed to build groupsGroup hierachy exceeded the maximum limit of 20 levels deep.
GLFound a loop inside groupA loop has been detected inside a group.
D  
RUnneeded result operationRegarded as unneeded during the last order explosion but was not deleted because results data was specified for the operation.

 

Update time
(FlagDate)

<RO>
<Standard>

Time

Updated when import/export/synchronization is executed. Note that this is not the time at which data is changed through the GUI, rescheduling, and so on.

All Properties

Resource code
(OCal_ResourceCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Resource. Mapped in DBIO's [Field mapping].

 

Code/Display name/Alias
(Object_CodeDisplayNameOrAlias)

String

Corresponds to the code, display name or alias depending on the setting in the property String display method of the workspace.

 

Currently editing user code
(Object_UserDuringChangeCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Currently editing user. Mapped in DBIO's [Field mapping].

 

User with right to edit code
(Object_UserDuringCheckOutCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Reserved right to edit user. Mapped in DBIO's [Field mapping].

 

Owner code
(Object_OwnerUserCode)

<RO> <Multi>

WBSRef

Temporarily used when importing/exporting Owner. Mapped in DBIO's [Field mapping].

 
 
ResourceCount
<LONG> Data Type
<RO>

 

Number of elements in Resource property's array.

 
TimeSeriesCount
<LONG> Data Type
<RO>

 

Number of elements in TimeSeries property's array.

 
ResQtyCount
<LONG> Data Type
<RO>

 

Number of elements in ResQty property's array.

 
CommentCount
<LONG> Data Type
<RO>

 

Number of elements in Comment property's array.

 
ChildAsOCalendar
<ASBOCalendar> Data Type
<RO>

 

Obtains the child object specified as Index.
[in:LONG]Index: Position of the child object.

 
AddChildAsOCalendar
<ASBOCalendar> Data Type
<Method>

 

Adds a child object with a newCode name.
[in:BSTR]newCode: Name of the new child object.


<RO> : Read-Only
<Multi> : Array Type (Starting From 1)

<Basic> : Displays in basic mode
<Standard> : Displays in standard mode

See Also

OCalendar


HelpNo.:C231

© Since 2018 Asprova Corporation, All rights reserved.