Calendar Class


( Specify here shifts to each resource for each date and day of the week. )

<ASBCalendar> Interface

 

Property Overview

TabProperty NameData TypeDescription

General

Resource
(Cal_Resource)

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

Object

Specify resource or resource group. An asterisk (*) means all resources.

 

Date or day of the week
(Cal_Dates)

<Multi>
<Basic><Standard>
Date
<ASVDateExpression> Data Type

Date expression

Specify dates. You can specify multiple dates by separating them with semicolons. Concatenating with a hyphen indicates the range.
Ex:
* (Every day)
2021/10/10 (Date)
2021/10/10;2021/10/15 (Multiple dates)
2021/10/10-2021/10/20 (Range of dates)
Mon (Day of week)
Mon;Thu (Multiple days of week)
Mon-Fri (Range of days of week)
HOLS (Dates in holiday table)
10 (10th every month)
10-20 (10th-20th every month)
20-EOM (20th to end of month)

 

Shift code
(Cal_ShiftCode)

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

String

Set the shift code in the shift table. After using COM IF's ASBCalendar::ShiftCode to set this property, it will be enabled after ASBProjectEx::BroadcastChanged is called. However, if the user wants to enable it before that, the user can call COM IF's ASBCalendar::ParseShiftCode to enable it. This is useful user wants to use it to change shift timings in KeyHookBeforeAssign, KeyHookAfterAssign events, create new calendar objects or add, change, or remove shift codes.

 

Shifts
(Cal_Shifts)

<RO> <Multi>
Shift
<ASOObject> Data Type

Object

Shifts.

 

Sort order
(Cal_SortOrder)

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

Float

If multiple calendar objects can be applied to the same day, the one with the largest sort order will be applied.

 

Resource quantity
(Cal_DefaultQty)

<Basic><Standard>
DefaultQty
<double> Data Type

Float

Available resource quantity.

 

Resource group quantity
(Cal_ResourceGroupQty)

<Standard>

Float

When using the group assign option, set the available resource quantity for assigning operation groups on resource groups. It will set the resource quantity of the resource groups in the [Resource] property. It won't affect on the resource group members.

 

Comments
(Cal_Comments)

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

String

Enter comments here. You can enter multiple comments by separating them with semicolons.

 

Extension field
(Cal_Extension)

<Multi>
<Standard>
Extension
<BSTR> Data Type

String

Valid only when the old Asprova mode or the normal mode converted from old Asprova is used.

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.

Internal

Daily calendar
(Cal_DailyCalendar)

<RO> <Multi>
<Standard>

Daily calendar

Daily calendars using this Calendar object. If this property has no value, it means that this Calendar object is never used, so that it can be deleted without effecting on the schedule.

 

Dedicated shift
(Cal_DedicatedShift)

<RO> <Multi>

Object

Internally used property.

All Properties

Resource code
(Cal_ResourceCode)

<Multi>

WBSRef

Resource code or resource group code.

 

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.

 
DateCount
<LONG> Data Type
<RO>

 

Number of elements in Date property's array.

 
ShiftCount
<LONG> Data Type
<RO>

 

Number of elements in Shift property's array.

 
CommentCount
<LONG> Data Type
<RO>

 

Number of elements in Comment property's array.

 
ExtensionCount
<LONG> Data Type
<RO>

 

Number of elements in Extension property's array.

 
ChildAsCalendar
<ASBCalendar> Data Type
<RO>

 

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

 
AddChildAsCalendar
<ASBCalendar> Data Type
<Method>

 

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

 
ParseShiftCode
<VOID> Data Type
<Method>

 

"It is used to make the shift code available forcely after calling ShfitCode (Not Shift) interface. Usually, the shift code is available after calling ASBProject::BroadcastChanged. If you don't want to wait until ASBProject::BroadcastChanged, or you want to change the working time in KeyHookBeforeAssign or KeyHookAfterAssign, this interface can be used to add, modify or delete the shift cde after creating a new calendar object, "

 
GetAsObject
<ASOObject> Data Type
<Method>

 

Obtains property value as object.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to obtain.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsObject
<VOID> Data Type
<Method>

 

Sets properties as object.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsInteger
<ASOObject> Data Type
<Method>

 

Obtains properties as integer.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsExpression
<ASOObject> Data Type
<Method>

 

Obtains properties as expression.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsTime
<ASOObject> Data Type
<Method>

 

Obtains properties as time.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsTimeSpan
<ASOObject> Data Type
<Method>

 

Obtains properties as time span.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsDouble
<ASOObject> Data Type
<Method>

 

Obtains properties as float.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsBool
<ASOObject> Data Type
<Method>

 

Obtains properties as boolean.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
GetAsEnum
<ASOObject> Data Type
<Method>

 

Obtains properties as enum.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsInteger
<VOID> Data Type
<Method>

 

Sets properties as integer.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsExpression
<VOID> Data Type
<Method>

 

Sets properties as expression.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsTime
<VOID> Data Type
<Method>

 

Sets properties as time.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsTimeSpan
<VOID> Data Type
<Method>

 

Sets properties as time span.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsDouble
<VOID> Data Type
<Method>

 

Sets properties as float.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsBool
<VOID> Data Type
<Method>

 

Sets properties as boolean.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
SetAsEnum
<VOID> Data Type
<Method>

 

Sets properties as enum.
[in:TPropertyID]PropertyID: Specifies the ID of the properties to set.
[in:LONG]Index: Specifies the Index of the property.

 
ShiftCodeCount
<LONG> Data Type
<RO>

 

Number of elements in ShiftCode property's array.


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

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

See Also

Calendar


HelpNo.:C13

© Since 2019 Asprova Corporation, All rights reserved.