The CalendarType provides a list of calendar dates. Each entry in the list describes a specific date or date pattern, or range of dates. The CalendarType ObjectType is formally defined in Table 4.
Table 4 – CalendarType Definition
Attribute |
Value |
|||||
BrowseName |
CalendarType |
|||||
IsAbstract |
False |
|||||
Description |
Provides a list of calendar dates. Each entry in the list describes a specific date or date pattern, or range of dates |
|||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
Other |
|
Subtype of the 0:BaseObjectType |
||||||
0:HasComponent |
Variable |
PresentValue |
0:Boolean |
0:BaseDataVariableType |
M |
|
0:HasProperty |
Variable |
DateList |
CalendarEntryType[] |
0:PropertyType |
M |
|
0:HasComponent |
Method |
AddDateListElements |
|
|
O |
|
0:HasComponent |
Method |
RemoveDateListElements |
|
|
O |
|
Conformance Units |
||||||
Scheduler Calendar Base |
This PresentValue indicates the current value of the calendar: True if the current date is in the DateList and False if it is not. For the current date that local time of the OPC UA Server shall be considered.
The DateList is an array of elements of which each is either a specific date or date pattern, or range of dates.
The child Nodes of the CalendarType have additional Attribute values defined in Table 5.
Table 5 – CalendarType Attribute values for child Nodes
BrowsePath |
Description Attribute |
PresentValue |
Indicates if the current date is in the DateList (true) or not (false) |
DateList |
Array of elements each defining either a specific date or date pattern, or range of dates |
AddDateListElements |
Adds elements to the DateList |
RemoveDateListElements |
Removes elements of the DateList |
This Method adds entries to the DateList Property. Even if one entry cannot be added, the other entries are still processed and added, if possible. The signature of this Method is specified below. Table 6 and Table 7 specify the Arguments and AddressSpace representation, respectively.
Signature
AddDateListElements (
[in] CalendarEntryType[] CalendarEntries
[out]0:Int32[] EntryResults
);
Table 6 – AddDateListElements Method Arguments
Argument |
Description |
CalendarEntries |
An array of calendar entries to be added to the DateList Property. |
EntryResults |
An array of results, one entry per entry in CalendarEntries, indicating if the individual entry could be added. Each result <> 0 indicates, that adding this calendar entry was not successful. 0 – OK -1 – Duplicate – Entry already in DateList -2 – Invalid Format – The entry contains an invalid format, e.g. an invalid range Values larger 0 can be used for vendor-specific errors. |
Method Result Codes (defined in Call Service)
Result Code |
Description |
BadNodeIdUnknown |
See OPC 10000-4 for a general description. |
BadNotWritable |
See OPC 10000-4 for a general description. |
BadOutOfMemory |
See OPC 10000-4 for a general description. |
Table 7 – AddDateListElements Method AddressSpace definition
Attribute |
Value |
||||
BrowseName |
AddDateListElements |
||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
This Method removes entries from the DateList Property. Even if one entry cannot be removed, the other entries are still processed and removed, if possible. The signature of this Method is specified below. Table 8 and Table 9 specify the Arguments and AddressSpace representation, respectively.
Signature
RemoveDateListElements (
[in] CalendarEntryType[] CalendarEntries
[out]0:Int32[] EntryResults
);
Table 8 – RemoveDateListElements Method Arguments
Argument |
Description |
CalendarEntries |
An array of calendar entries to be removed from the DateList Property. |
EntryResults |
An array of results, one entry per entry in CalendarEntries, indicating if the individual entry could be removed. Each result <> 0 indicates, that removing this calendar entry was not successful. 0 – OK -1 – Not found – Entry is not in DateList Values larger 0 can be used for vendor-specific errors. |
Method Result Codes (defined in Call Service)
Result Code |
Description |
BadNodeIdUnknown |
See OPC 10000-4 for a general description. |
BadNotWritable |
See OPC 10000-4 for a general description. |
Table 9 – RemoveDateListElements Method AddressSpace definition
Attribute |
Value |
||||
BrowseName |
RemoveDateListElements |
||||
References |
NodeClass |
BrowseName |
DataType |
TypeDefinition |
ModellingRule |
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
0:Mandatory |