CYBOL API Specification Version 0.27.0

access/count

Description

Counts the child nodes of a compound node of type "element/part" or "element/property".

Examples

Properties

Name	Required	Format	Description
count	true	text/cybol-path	The number of counted child nodes as result.
part	true	text/cybol-path	The compound node of type

access/get-format

Description

Retrieves a part's format.

Examples

Properties

Name	Required	Format	Description
element	true	text/cybol-path	The part's format as return value.
part	true	text/cybol-path	The node whose format is to be retrieved.

access/get-name

Description

Retrieves a part's name.

Examples

Properties

Name	Required	Format	Description
element	true	text/cybol-path	The part's name as return value.
part	true	text/cybol-path	The node whose name is to be retrieved.

access/get-type

Description

Retrieves a part's type.

Examples

Properties

Name	Required	Format	Description
element	true	text/cybol-path	The part's type as return value.
part	true	text/cybol-path	The node whose type is to be retrieved.

access/indicate-empty

Description

Indicates if the given part is empty, that is its count is zero.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The flag being set to true if the part is empty, or being left untouched otherwise.
part	true	text/cybol-path	The node which is to be checked for emptiness.

access/indicate-exists

Description

Indicates if the given part is not empty, that is its count is greater than zero.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The flag being set to true if the part is not null and not empty, or being left untouched otherwise.
part	true	text/cybol-path	The node which is to be checked for existence and non-empty data.

activate/disable

Description

Disables the communication channel, so that no more requests/events can be detected.

Examples

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
port	false	text/cybol-path \| number/integer	The service identification, for example http socket port 80. If null, the default is zero, for example with channel display.

activate/enable

Description

Enables the communication channel, so that requests/events can be detected. Calling the operation "feel/sense" afterwards is not necessary for channel "display" on a linux operating system with x window system, since "activate/enable" catches the events of all client windows. On a windows operating system, however, one separate event thread is run per window, so that calling "feel/sense" after this "activate/enable" is necessary. Calling this operation "activate/enable" is not necessary for channels "terminal" or "serial", since clients get opened manually using "dispatch/open" and events can be detected right afterwards using the operation "feel/sense". The requesting client gets appended to an internal accept buffer list. It can be accessed in operation "dispatch/open" using the property "identification". However, this works only, if the "server" flag is set to true, so that the client is read from the accept buffer list.

Examples

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
port	false	text/cybol-path \| number/integer	The service identification, for example http socket port 80. If null, the default is zero, for example with channel display.
handler	false	text/cybol-path	The callback cybol model to be executed upon arrival of a request/event.

calculate/absolute

Description

Determines the absolute value of a number.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The absolute value of the given number.
operand	true	text/cybol-path \| number/any	The source number.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/add

Description

Adds the operand to the result. sum = summand + summand Caution! Do not use this operation for adding characters (strings)! They may be concatenated by using the "modify/append" operation.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The sum resulting from the addition. It initially represents the first summand.
operand	true	text/cybol-path \| number/any	The second summand.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/divide

Description

Divides the result by the operand. quotient = dividend / divisor

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The quotient resulting from the division. It initially represents the dividend.
operand	true	text/cybol-path \| number/any	The divisor.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/maximum

Description

Determines the greater of two values.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The greater of the two given values. It initially represents the first value.
operand	true	text/cybol-path \| number/any	The second value.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/minimum

Description

Determines the lesser of two values.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The lesser of the two given values. It initially represents the first value.
operand	true	text/cybol-path \| number/any	The second value.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/modulo

Description

Determines the remainder of the integer division. remainder = dividend % divisor

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The remainder of the integer division. It initially represents the dividend.
operand	true	text/cybol-path \| number/any	The divisor.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/multiply

Description

Multiplies the result with the operand. product = factor * factor

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The product resulting from the multiplication. It initially represents the first factor.
operand	true	text/cybol-path \| number/any	The second factor.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/negate

Description

Negates a number by altering its sign. result = - operand

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The negated number.
operand	true	text/cybol-path \| number/any	The number to be negated.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/reduce

Description

Reduces a vulgar fraction to the lowest possible denominator.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The reduced vulgar fraction with lowest possible denominator.
operand	true	text/cybol-path \| number/any	The vulgar fraction to be reduced.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

calculate/subtract

Description

Subtracts the operand from the result. difference = minuend - subtrahend

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The difference resulting from the subtraction. It initially represents the minuend.
operand	true	text/cybol-path \| number/any	The subtrahend.
count	false	text/cybol-path \| number/integer	The number of elements to be calculated. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
result_index	false	text/cybol-path \| number/integer	The result index from where to start calculating. If null, the default is zero.
operand_index	false	text/cybol-path \| number/integer	The operand index from where to start calculating. If null, the default is zero.

cast/byte

Description

Casts a value to type "byte".

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination value with the desired type to cast to.
source	true	text/cybol-path \| number/any	The source value to cast from.
count	false	text/cybol-path \| number/integer	The number of elements to be casted. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
destination_index	false	text/cybol-path \| number/integer	The destination index from where to start writing values to. If null, the default is zero.
source_index	false	text/cybol-path \| number/integer	The source index from where to start reading values from. If null, the default is zero.

cast/character

Description

Casts a value to type "character".

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination value with the desired type to cast to.
source	true	text/cybol-path \| number/any	The source value to cast from.
count	false	text/cybol-path \| number/integer	The number of elements to be casted. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
destination_index	false	text/cybol-path \| number/integer	The destination index from where to start writing values to. If null, the default is zero.
source_index	false	text/cybol-path \| number/integer	The source index from where to start reading values from. If null, the default is zero.

cast/double

Description

Casts a value to type "double".

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination value with the desired type to cast to.
source	true	text/cybol-path \| number/any	The source value to cast from.
count	false	text/cybol-path \| number/integer	The number of elements to be casted. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
destination_index	false	text/cybol-path \| number/integer	The destination index from where to start writing values to. If null, the default is zero.
source_index	false	text/cybol-path \| number/integer	The source index from where to start reading values from. If null, the default is zero.

cast/integer

Description

Casts a value to type "integer".

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination value with the desired type to cast to.
source	true	text/cybol-path \| number/any	The source value to cast from.
count	false	text/cybol-path \| number/integer	The number of elements to be casted. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
destination_index	false	text/cybol-path \| number/integer	The destination index from where to start writing values to. If null, the default is zero.
source_index	false	text/cybol-path \| number/integer	The source index from where to start reading values from. If null, the default is zero.

check/equal

Description

Checks lexicographically if left and right value are equal. Lexicographical comparison is usually applied to text, but can be used for vectors of other types as well. Even though both operands are vectors, there is always just one boolean result value altogether. Internally, the lexicographical flag is set to true also when doing deep comparison of compound parts of type "element/part", so that only one result value gets returned.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value resulting from lexicographical comparison.
left	true	text/cybol-path \| text/plain	The left operand.
right	true	text/cybol-path \| text/plain	The right operand.

check/greater

Description

Checks lexicographically if the left value is greater than the right value. Lexicographical comparison is usually applied to text, but can be used for vectors of other types as well. Even though both operands are vectors, there is always just one boolean result value altogether. Internally, the lexicographical flag is set to true also when doing deep comparison of compound parts of type "element/part", so that only one result value gets returned.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value resulting from lexicographical comparison.
left	true	text/cybol-path \| text/plain	The left operand.
right	true	text/cybol-path \| text/plain	The right operand.

check/greater-or-equal

Description

Checks lexicographically if the left value is greater than the right value or both are equal. Lexicographical comparison is usually applied to text, but can be used for vectors of other types as well. Even though both operands are vectors, there is always just one boolean result value altogether. Internally, the lexicographical flag is set to true also when doing deep comparison of compound parts of type "element/part", so that only one result value gets returned.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value resulting from lexicographical comparison.
left	true	text/cybol-path \| text/plain	The left operand.
right	true	text/cybol-path \| text/plain	The right operand.

check/less

Description

Checks lexicographically if the left value is less than the right value. Lexicographical comparison is usually applied to text, but can be used for vectors of other types as well. Even though both operands are vectors, there is always just one boolean result value altogether. Internally, the lexicographical flag is set to true also when doing deep comparison of compound parts of type "element/part", so that only one result value gets returned.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value resulting from lexicographical comparison.
left	true	text/cybol-path \| text/plain	The left operand.
right	true	text/cybol-path \| text/plain	The right operand.

check/less-or-equal

Description

Checks lexicographically if the left value is less than the right value or both are equal. Lexicographical comparison is usually applied to text, but can be used for vectors of other types as well. Even though both operands are vectors, there is always just one boolean result value altogether. Internally, the lexicographical flag is set to true also when doing deep comparison of compound parts of type "element/part", so that only one result value gets returned.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value resulting from lexicographical comparison.
left	true	text/cybol-path \| text/plain	The left operand.
right	true	text/cybol-path \| text/plain	The right operand.

check/unequal

Description

Checks lexicographically if left and right value are unequal. Lexicographical comparison is usually applied to text, but can be used for vectors of other types as well. Even though both operands are vectors, there is always just one boolean result value altogether. Internally, the lexicographical flag is set to true also when doing deep comparison of compound parts of type "element/part", so that only one result value gets returned.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value resulting from lexicographical comparison.
left	true	text/cybol-path \| text/plain	The left operand.
right	true	text/cybol-path \| text/plain	The right operand.

command/archive

Description

Archives the given files into a packed format via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
create	false	text/cybol-path \| logicvalue/boolean	The flag indicating the creation of an archive.
update	false	text/cybol-path \| logicvalue/boolean	The flag indicating the updating of an archive.
bzip2	false	text/cybol-path \| logicvalue/boolean	The flag indicating usage of the bzip2 compression algorithm.

command/change-directory

Description

Changes the current working directory via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
directory	true	text/cybol-path \| text/plain	The new working directory.

command/change-permission

Description

Changes the permission of a file or directory via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
path	true	text/cybol-path \| text/plain	The filesystem path to the file or directory.
user	true	text/cybol-path \| text/plain	TODO
group	true	text/cybol-path \| text/plain	TODO
other	true	text/cybol-path \| text/plain	TODO
recursive	false	text/cybol-path \| logicvalue/boolean	The flag indicating recursive processing.
silent	false	text/cybol-path \| logicvalue/boolean	The flag indicating suppression of errors.
verbose	false	text/cybol-path \| logicvalue/boolean	The flag indicating that a diagnostic output is wanted for every file.

command/clear

Description

Clears the terminal (console) screen via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/compare-files

Description

Compares two files via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/config-network

Description

Configures the network via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/copy

Description

Copies the given file into another via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
source	true	text/cybol-path \| text/plain	The source file to be copied.
destination	true	text/cybol-path \| text/plain	The destination to copy to.
force	false	text/cybol-path \| logicvalue/boolean	The flag indicating not to ask for permission for overwriting files or directories.
interactive	false	text/cybol-path \| logicvalue/boolean	The flag indicating to ask everytime for permission of overwriting a file or directory.
preserve_all_attributes	false	text/cybol-path \| logicvalue/boolean	The flag indicating that copied files and directories will have the same attributes as the originals.
preserve_links	false	text/cybol-path \| logicvalue/boolean	The flag indicating that links are preserved so that they are not dereferenced while copying.
recursive	false	text/cybol-path \| logicvalue/boolean	The flag indicating that all sub directories should be copied as well.
update	false	text/cybol-path \| logicvalue/boolean	The flag indicating that just more recent data are copied to a destination path.
verbose	false	text/cybol-path \| logicvalue/boolean	The flag indicating that the names of copied files and directories are shown.

command/create-directory

Description

Creates a directory (folder) in the file system via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
path	true	text/cybol-path	The filesystem path to the directory to be created.

command/date

Description

Prints out the date or changes it via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
new	false	text/cybol-path	The value of the new date.

command/delay

Description

Delays execution for the given number of seconds via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
time	true	text/cybol-path \| number/integer	The time in seconds.

command/diff

Description

Displays differences between two files via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
first	true	text/cybol-path \| text/plain	The first file.
second	true	text/cybol-path \| text/plain	The second file.

command/disk-free

Description

Displays the free disk space via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
all	false	text/cybol-path \| logicvalue/boolean	The flag indicating that files with a size of 0 blocks shall be listed.
human	false	text/cybol-path \| logicvalue/boolean	The flag indicating human-readable output.
kilobytes	false	text/cybol-path \| logicvalue/boolean	The flag indicating size output in kilobytes.
local	false	text/cybol-path \| logicvalue/boolean	The flag indicating that only local filesystems shall be listed.
megabytes	false	text/cybol-path \| logicvalue/boolean	The flag indicating size output in megabytes.
type	false	text/cybol-path \| logicvalue/boolean	The flag indicating output of each filesystem's type.

command/disk-usage

Description

Shows the usage of a directory via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
human	false	text/cybol-path \| logicvalue/boolean	The flag indicating human-readable output.
summarise	false	text/cybol-path \| logicvalue/boolean	The flag indicating that a summary shall be printed.
all	false	text/cybol-path \| logicvalue/boolean	The flag indicating that all shall be printed.
bytes	false	text/cybol-path \| logicvalue/boolean	The flag indicating size output in bytes.
total	false	text/cybol-path \| logicvalue/boolean	The flag indicating that the total usage shall be printed.

command/display-content

Description

Displays the content of one or more text files via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
path	false	text/cybol-path \| text/plain	The file whose content is to be printed.
clear	false	text/cybol-path \| logicvalue/boolean	The flag indicating to clear the screen before display.
numbers	false	text/cybol-path \| logicvalue/boolean	The flag indicating that output lines shall be numbered.
squeeze	false	text/cybol-path \| logicvalue/boolean	The flag indicating that multiple blank lines shall be merged into a single line.

command/echo

Description

Prints the given message to standard output via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
message	false	text/cybol-path \| text/plain	The message to be sent to standard output.

command/find-command

Description

Locates the command binary, source, or manual page files via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	falsefalsefalsefalse	text/cybol-path	TODO

command/find-file

Description

Finds a file via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	falsefalsefalse	text/cybol-path	TODO

command/grep

Description

Searches for a pattern in the file and prints out those lines matching the pattern via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	falsefalse	text/cybol-path	TODO

command/help

Description

Displays information about a system command via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/hostname

Description

Displays the name of the host (machine) via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/id

Description

Displays the identification (id) of the user or group via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/ifconfig

Description

Calls ifconfig via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/ifup

Description

Shows if the network interface is available, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/kill

Description

Kills an application or system process via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/list-directory-contents

Description

Lists the contents of the given directory via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/list-open-files

Description

Shows open files in operating system via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/list-tasks

Description

Lists all processes currently running on the computer, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/memory-free

Description

Shows the usage of Random Access Memory (RAM), via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/move

Description

Moves a file or directory to a destination path, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/netstat

Description

Displays network information via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/ping

Description

Pings the given host via network, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/pwd

Description

Prints the path of the current working directory, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/remove

Description

Removes a file or directory via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/sort

Description

Sorts the lines of a text file, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/spellcheck

Description

Spellchecks a file via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/system-messages

Description

Shows system messages from /var/log via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/tape-archiver

Description

Packs or unpacks a directory or file, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/top

Description

Displays the linux processes, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/touch

Description

Changes the timestamp of a file via shell command. May be used to create a new file. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/traceroute

Description

Traces and displays the packet route to the given host, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
host	true	text/cybol-path \| text/plain	The host to trace the route to.

command/userlog

Description

Shows the users currently logged in to the machine, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

command/who

Description

Displays information about the current user, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/who-am-i

Description

Displays the login name of the current user, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

command/word-count

Description

Counts different occurences and outputs the number of rows, words and bytes for every file, via shell command. TODO: COMPLETE AND VERIFY YET!

Examples

Properties

Name	Required	Format	Description
TODO	false	text/cybol-path	TODO

communicate/identify

Description

Identifies the device or client that has placed a request (handler) into the interrupt pipe.

Examples

<node name="get_window_id" channel="inline" format="communicate/identify" model=""> <node name="identification" channel="inline" format="text/cybol-path" model=".gui.window_id"/> </node>  <node name="get_client_socket_id" channel="inline" format="communicate/identify" model=""> <node name="identification" channel="inline" format="text/cybol-path" model=".client_socket"/> </node>

Properties

Name	Required	Format	Description
identification	true	text/cybol-path	The device or client identification, for example a file descriptor.

communicate/receive

Description

Receives a message via the communication channel. Caution! Some file formats (like the German xDT format for medical data exchange) contain both, the model and the properties, in one file. To cover these cases, the model and properties are received together, in just one operation.

Examples

<node name="open_file" channel="inline" format="dispatch/open" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> <node name="device" channel="inline" format="text/plain" model="counter/simple/app.cybol"/> </node> <node name="initialise_app" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="sender" channel="inline" format="text/cybol-path" model=".id"/> <node name="encoding" channel="inline" format="meta/encoding" model="utf-8"/> <node name="language" channel="inline" format="meta/language" model="text/cybol"/> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="message" channel="inline" format="text/cybol-path" model="."/> </node> <node name="close_file" channel="inline" format="dispatch/close" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> </node>  <node name="open_file" channel="inline" format="dispatch/open" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> <node name="device" channel="inline" format="text/plain" model="serialisation/xml/test/reference.xml"/> </node> <node name="deserialise_data" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="sender" channel="inline" format="text/cybol-path" model=".id"/> <node name="encoding" channel="inline" format="meta/encoding" model="utf-8"/> <node name="language" channel="inline" format="meta/language" model="application/xml"> <node name="normalisation" channel="inline" format="logicvalue/boolean" model="false"/> </node> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="message" channel="inline" format="text/cybol-path" model=".data"/> </node> <node name="close_file" channel="inline" format="dispatch/close" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> </node>  <node name="open_file" channel="inline" format="dispatch/open" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> <node name="device" channel="inline" format="text/plain" model="serialisation/json/test/scenario/default.json"/> </node> <node name="deserialise_data" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="sender" channel="inline" format="text/cybol-path" model=".id"/> <node name="encoding" channel="inline" format="meta/encoding" model="utf-8"/> <node name="language" channel="inline" format="meta/language" model="application/json"/> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="message" channel="inline" format="text/cybol-path" model=".data"/> </node> <node name="close_file" channel="inline" format="dispatch/close" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> </node>  <node name="open_file" channel="inline" format="dispatch/open" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> <node name="device" channel="inline" format="text/cybol-path" model="#filename"/> </node> <node name="receive_file" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="sender" channel="inline" format="text/cybol-path" model=".id"/> <node name="encoding" channel="inline" format="meta/encoding" model="utf-8"/> <node name="language" channel="inline" format="meta/language" model="text/csv"> <node name="delimiter" channel="inline" format="text/cybol-path" model="#delimiter"/> <node name="quotation" channel="inline" format="text/cybol-path" model="#quotation"/> <node name="header" channel="inline" format="text/cybol-path" model="#header"/> </node>  <node name="message" channel="inline" format="text/cybol-path" model="{#table}"/> </node> <node name="close_file" channel="inline" format="dispatch/close" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> </node>  <node name="receive_command" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="sender" channel="inline" format="text/cybol-path" model=".var.stdin"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="message" channel="inline" format="text/cybol-path" model="#command"/>  <node name="asynchronicity" channel="inline" format="logicvalue/boolean" model="true"/> </node>  <node name="receive_event" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="display"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="sender" channel="inline" format="text/cybol-path" model=".gui.window_id"/> <node name="language" channel="inline" format="meta/language" model="message/gui-request"> <node name="medium" channel="inline" format="text/cybol-path" model=".gui.window"/> </node> <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/cybol-path" model=".gui.action"/>  <node name="asynchronicity" channel="inline" format="logicvalue/boolean" model="true"/> </node>  <node name="open_file" channel="inline" format="dispatch/open" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> <node name="device" channel="inline" format="text/cybol-path" model=".var.path"/> </node> <node name="receive_file" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="sender" channel="inline" format="text/cybol-path" model=".id"/> <node name="language" channel="inline" format="meta/language" model="message/binary"/> <node name="message" channel="inline" format="text/cybol-path" model=".var.file"/> </node> <node name="close_file" channel="inline" format="dispatch/close" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> </node>  <node name="receive_request" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="port" channel="inline" format="number/integer" model="1971"/> <node name="sender" channel="inline" format="text/cybol-path" model=".var.client_socket"/> <node name="language" channel="inline" format="meta/language" model="message/http-request"/> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="message" channel="inline" format="text/cybol-path" model=".var.request"/>  <node name="asynchronicity" channel="inline" format="logicvalue/boolean" model="true"/> </node>  <node name="receive_request" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="port" channel="inline" format="number/integer" model="1971"/> <node name="sender" channel="inline" format="text/cybol-path" model=".client_socket"/> <node name="language" channel="inline" format="meta/language" model="message/binary-crlf"/> <node name="message" channel="inline" format="text/cybol-path" model=".request"/>  <node name="asynchronicity" channel="inline" format="logicvalue/boolean" model="true"/> </node>  <node name="receive_response" channel="inline" format="communicate/receive" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="sender" channel="inline" format="text/cybol-path" model=".server_socket"/> <node name="language" channel="inline" format="meta/language" model="message/binary-crlf"/> <node name="message" channel="inline" format="text/cybol-path" model=".response"/> </node>

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
server	false	text/cybol-path \| logicvalue/boolean	The flag indicating server mode. It means server-side client stub and not standalone client. If null, the default is false (client mode).
port	false	text/cybol-path \| number/integer	The service identification. It is relevant only in server mode.
sender	true	text/cybol-path	The device identification, for example a file descriptor. Handing it over as hard-coded integer value does not make sense, since the operating system or server assigns it. Therefore, state a cybol-path.
encoding	false	text/cybol-path \| meta/encoding	The encoding, for example utf-8 or utf-32 or ascii.
language	false	text/cybol-path \| meta/language	The language used for deserialisation. It is also defining which prefix or suffix indicates the message length, for example binary-crlf, http-request, xdt.
format	false	text/cybol-path \| meta/format	The format (type) of the message data.
message	true	text/cybol-path	The knowledge tree node storing the received data.
asynchronicity	false	text/cybol-path \| logicvalue/boolean	The flag indicating asynchronous reading from buffer in which data got stored by a sensing thread before. If null, the default is false (synchronous read).

Constraints (language_constraints)

Name	Required	Format	Description
decimal_separator	false	text/plain	The symbol (or character sequence) used to separate the integer part from the fractional part of a floating point (decimal) number.
thousands_separator	false	text/plain	The symbol (or character sequence) used for digit grouping.
delimiter	false	text/plain	The separator between the single fields (values). It may consist of many characters, but also be a simple comma, for example. Used with joined strings or character (comma) separated values (csv).
quotation	false	text/plain	The marker sequence used at the beginning and end of string fields (values). It may consist of many characters. Quotation is necessary if the delimiter character is part of the value. If the quotation is to be part of the value, then it has to be escaped by writing it twice (doubled). Used with joined strings or character (comma) separated values (csv).
header	false	logicvalue/boolean	The flag indicating whether or not the source data contain a header, so that the deserialiser can treat the first line differently. Used with character (comma) separated values (csv). Caution! It should not be mixed up with the headermodel property in represent/serialise or communicate/send.
normalisation	false	logicvalue/boolean	The flag indicating whether or not whitespaces and line breaks are merged into just one space. Used with xml or html, for example. If null, then the default is true (normalisation enabled).
maximum	false	number/integer	The maximum number of bytes to be transmitted. Used with serial (port) interface.
minimum	false	number/integer	The minimum number of bytes to be transmitted. Used with serial (port) interface.
medium	false	text/cybol-path	The window to which the mouse button or keyboard key refers. It is needed to search through the hierarchy of gui elements via mouse coordinates, for a suitable action. Used with graphical user interface (gui).

communicate/send

Description

Sends a message via the communication channel.

Examples

<node name="send_exit_signal" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="signal"/> <node name="message" channel="inline" format="live/exit" model=""/> </node>  <node name="send_signal_taken_from_file" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="signal"/> <node name="message" channel="file" format="element/part" model="exit/file/exit.cybol"/> </node>  <node name="say_hello" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".var.stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/plain" model="Hello World!"/> </node>  <node name="print_query" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/cybol-path" model=".var.request:uri:query.action"/> </node>  <node name="print_request" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="format" channel="inline" format="meta/format" model="application/octet-stream"/> <node name="message" channel="inline" format="text/cybol-path" model=".request"/> </node>  <node name="log_flag" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="format" channel="inline" format="meta/format" model="logicvalue/boolean"/> <node name="message" channel="inline" format="text/cybol-path" model=".result_flag"/> </node>  <node name="print_number" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="format" channel="inline" format="meta/format" model="number/integer"/> <node name="message" channel="inline" format="text/cybol-path" model=".index"/> </node>  <node name="print_adc_value" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="format" channel="inline" format="meta/format" model="number/fraction-decimal"/> <node name="message" channel="inline" format="text/cybol-path" model=".settings.adc"/> </node>  <node name="send_menu" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui"> <node name="clear" channel="inline" format="logicvalue/boolean" model="true"/> <node name="positioning" channel="inline" format="logicvalue/boolean" model="true"/> </node> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="message" channel="inline" format="text/cybol-path" model=".tui.main"/> </node> <node name="set_cursor" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui">  <node name="positioning" channel="inline" format="logicvalue/boolean" model="true"/> </node>  <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/cybol-path" model=".tui.cursor"/> </node>  <node name="refresh_display" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="display"/>  <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".gui.window_id"/> <node name="language" channel="inline" format="meta/language" model="message/gui-response"/> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="message" channel="inline" format="text/cybol-path" model=".gui.window"/> </node>  <node name="open_file" channel="inline" format="dispatch/open" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> <node name="device" channel="inline" format="text/plain" model="counter/simple/test_counter_simple.txt"/> <node name="mode" channel="inline" format="text/plain" model="write"/> </node> <node name="send_knowledge_tree_root" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".id"/> <node name="encoding" channel="inline" format="meta/encoding" model="utf-8"/> <node name="language" channel="inline" format="meta/language" model="text/model-diagram"/> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="message" channel="inline" format="text/cybol-path" model="."/> </node> <node name="close_file" channel="inline" format="dispatch/close" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="identification" channel="inline" format="text/cybol-path" model=".id"/> </node>  <node name="test_file_content" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".id"/> <node name="language" channel="inline" format="meta/language" model="message/binary"/> <node name="message" channel="inline" format="text/cybol-path" model=".var.file"/> </node>  <node name="generate_html" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".id"/> <node name="encoding" channel="inline" format="meta/encoding" model="utf-8"/> <node name="language" channel="inline" format="meta/language" model="text/html"> <node name="indentation" channel="inline" format="logicvalue/boolean" model="true"/> </node> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="message" channel="inline" format="text/cybol-path" model=".wui.index"/> </node>  <node name="serialise_webpage" channel="inline" format="represent/serialise" model=""> <node name="destination" channel="inline" format="text/cybol-path" model=".var.webpage"/> <node name="source" channel="inline" format="text/cybol-path" model=".wui.index"/> <node name="format" channel="inline" format="meta/format" model="element/part"/> <node name="language" channel="inline" format="meta/language" model="text/html"/> </node> <node name="write_serialised_webpage_into_file" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".id"/> <node name="encoding" channel="inline" format="meta/encoding" model="utf-8"/> <node name="language" channel="inline" format="meta/language" model="text/cybol"/> <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/cybol-path" model=".var.webpage"/> </node>  <node name="test_http_response" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="file"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".id"/> <node name="language" channel="inline" format="meta/language" model="message/http-response"/> <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/cybol-path" model=".var.webpage"> <node name="Server" channel="inline" format="text/plain" model="CYBOI/0.22.0 (Linux) CYBOL/2.0.0"/> <node name="Connection" channel="inline" format="text/plain" model="close"/> <node name="Content-Type" channel="inline" format="text/plain" model="text/html"/> </node> </node>  <node name="send_hello" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="port" channel="inline" format="number/integer" model="1971"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".client_socket"/> <node name="language" channel="inline" format="meta/language" model="message/binary-crlf"/> <node name="message" channel="inline" format="application/octet-stream" model="Hello World!"/> </node>  <node name="send_file" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="port" channel="inline" format="number/integer" model="1971"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".var.client_socket"/> <node name="language" channel="inline" format="meta/language" model="message/http-response"/> <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/cybol-path" model=".var.file"/> </node>  <node name="send_empty_message" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="port" channel="inline" format="number/integer" model="1971"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".var.client_socket"/> <node name="language" channel="inline" format="meta/language" model="message/http-response"/> <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/plain" model=""/> </node>  <node name="send" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="port" channel="inline" format="number/integer" model="1971"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".var.client_socket"/> <node name="language" channel="inline" format="meta/language" model="message/http-response"/> <node name="format" channel="inline" format="meta/format" model="text/plain"/>  <node name="message" channel="inline" format="text/cybol-path" model=".var.webpage"> <node name="Connection" channel="inline" format="text/plain" model="keep-alive"/>   <node name="Keep-Alive" channel="inline" format="text/plain" model="timeout=300, max=1000"/> </node> </node>  <node name="send_request" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".server_socket"/> <node name="language" channel="inline" format="meta/language" model="message/binary-crlf"/> <node name="message" channel="inline" format="application/octet-stream" model="say-hello"/> </node>

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
server	false	text/cybol-path \| logicvalue/boolean	The flag indicating server mode. It means server-side client stub and not standalone client. If null, the default is false (client mode).
port	false	text/cybol-path \| number/integer	The service identification. It is relevant only in server mode.
receiver	true	text/cybol-path	The device identification, for example a file descriptor. Handing it over as hard-coded integer value does not make sense, since the operating system or server assigns it. Therefore, state a cybol-path.
encoding	false	text/cybol-path \| meta/encoding	The encoding, for example utf-8 or utf-32 or ascii.
language	false	text/cybol-path \| meta/language	The language used for serialisation, for example model-diagram, html, binary-crlf, http-response, xdt.
format	false	text/cybol-path \| meta/format	The format (type) of the message data.
message	true	text/cybol-path \| application/octet-stream \| any	The data to be sent.
asynchronicity	false	text/cybol-path \| logicvalue/boolean	The flag indicating asynchronous writing within a thread. If null, the default is false (synchronous write).
handler	false	text/cybol-path	The callback cybol operation being executed when the thread finished writing data.

Constraints (language_constraints)

Name	Required	Format	Description
sign	false	logicvalue/boolean	The flag indicating whether or not a plus sign is to be displayed for positive numbers. Negative numbers have a minus sign in any case. If null, the default is false (no plus sign for positive numbers).
base	false	number/integer	The number base for example 2 for binary (dual), 8 for octal, 10 for decimal, 16 for hexadecimal. If null, the default is 10 (decimal number base).
classicoctal	false	logicvalue/boolean	The flag indicating whether or not the octal number base prefix is to be displayed as 0 as in classic c/c++ or using modern style 0o as in perl and python. If null, the default is false (modern style with prefix 0o).
grouping	false	text/plain	The symbol or character sequence used for digit grouping in thousands. If null, the default is not to use any thousands separator at all.
separator	false	text/plain	The symbol or character sequence used to separate the integer part from the fractional part of a floating point decimal number. If null, the default is to use the full stop (dot).
decimals	false	number/integer	The number of post-point decimal places (decimals). If null, the default is 4.
scientific	false	logicvalue/boolean	The flag indicating whether or not the decimal fraction gets displayed with mantissa and exponent. If null, the default is false (standard representation without exponent).
polar	false	logicvalue/boolean	The flag indicating whether or not to write the complex number using polar coordinates. If null, the default is false (using the cartesian form).
newline	false	logicvalue/boolean	The flag indicating whether or not a line break is added at the end of the printed characters. If null, the default is true (line gets broken). Used with text (pseudo) terminal.
clear	false	logicvalue/boolean	The flag indicating whether or not the terminal screen is cleared before printing characters on it. If null, the default is false (no clearing). Used with text (pseudo) terminal.
positioning	false	logicvalue/boolean	The flag indicating whether or not the cursor position may get changed. If null, the default is false (no repositioning). Used with text (pseudo) terminal.
indentation	false	logicvalue/boolean	The flag indicating whether or not the serialised data get beautified (pretty-formatted) by indenting the single lines depending on the hierarchy level. Used with xml or html, for example.
delimiter	false	text/plain	The separator between the single fields (values). It may consist of many characters, but also be a simple comma, for example. Used with joined strings or character (comma) separated values (csv).
quotation	false	text/plain	The marker sequence used at the beginning and end of string fields (values). It may consist of many characters. Quotation is necessary if the delimiter character is part of the value. If the quotation is to be part of the value, then it has to be escaped by writing it twice (doubled). Used with joined strings or character (comma) separated values (csv).
normalisation	false	logicvalue/boolean	The flag indicating whether or not whitespaces and line breaks are merged into just one space. Used with xml or html, for example. If null, then the default is true (normalisation enabled).
width	false	number/integer	The number of characters (or digits) belonging to a value. Free places get filled up with the character given in the fill property. This was defined in the original specification of character (comma) separated values (csv), in order to have fields (values) with equal width. Used with joined strings or csv.
fill	false	text/plain	The characters (or digit) to be used to fill free places in a value whose width is greater.
headermodel	false	text/cybol-path	The header data to be written as first line, yet before the actual content. Used with character (comma) separated values (csv). Caution! It should not be mixed up with the header property flag in represent/deserialise or communicate/receive.

compare/equal

Description

Compares if left and right value are equal. Commonly used operator in other programming languages: == Left and right operand as well as the boolean result are treated as vector. That is, one boolean result value is returned per each operand vector element. When comparing single elements, the vectors contain just one single value. Numbers may be given as vectors, for example the integer sequence "1,2,3". If using text operands, for example "Hello, World!", then the single characters are compared, one by one. Example with many elements: - operation: equal - left: 10,2,3 - right: 1,2,3 - result: 0,1,1 (which corresponds to "false,true,true") Example with one single element: - operation: equal - left: 33 - right: 3 - result: 0 (which corresponds to "false")

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value vector resulting from comparison.
left	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The left operand vector.
right	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The right operand vector.
count	false	text/cybol-path \| number/integer	The number of elements to be compared. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
left_index	false	text/cybol-path \| number/integer	The left index from where to start the comparison from. If null, the default is zero.
right_index	false	text/cybol-path \| number/integer	The right index from where to start the comparison from. If null, the default is zero.

compare/greater

Description

Compares if the left value is greater than the right value. Commonly used operator in other programming languages: > Left and right operand as well as the boolean result are treated as vector. That is, one boolean result value is returned per each operand vector element. When comparing single elements, the vectors contain just one single value. Numbers may be given as vectors, for example the integer sequence "1,2,3". If using text operands, for example "Hello, World!", then the single characters are compared, one by one. Example with many elements: - operation: greater - left: 10,2,3 - right: 1,2,3 - result: 0,1,1 (which corresponds to "false,true,true") Example with one single element: - operation: greater - left: 33 - right: 3 - result: 0 (which corresponds to "false")

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value vector resulting from comparison.
left	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The left operand vector.
right	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The right operand vector.
count	false	text/cybol-path \| number/integer	The number of elements to be compared. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
left_index	false	text/cybol-path \| number/integer	The left index from where to start the comparison from. If null, the default is zero.
right_index	false	text/cybol-path \| number/integer	The right index from where to start the comparison from. If null, the default is zero.

compare/greater-or-equal

Description

Compares if the left value is greater than the right value or both are equal. Commonly used operator in other programming languages: >= Left and right operand as well as the boolean result are treated as vector. That is, one boolean result value is returned per each operand vector element. When comparing single elements, the vectors contain just one single value. Numbers may be given as vectors, for example the integer sequence "1,2,3". If using text operands, for example "Hello, World!", then the single characters are compared, one by one. Example with many elements: - operation: greater-or-equal - left: 10,2,3 - right: 1,2,3 - result: 0,1,1 (which corresponds to "false,true,true") Example with one single element: - operation: greater-or-equal - left: 33 - right: 3 - result: 0 (which corresponds to "false")

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value vector resulting from comparison.
left	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The left operand vector.
right	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The right operand vector.
count	false	text/cybol-path \| number/integer	The number of elements to be compared. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
left_index	false	text/cybol-path \| number/integer	The left index from where to start the comparison from. If null, the default is zero.
right_index	false	text/cybol-path \| number/integer	The right index from where to start the comparison from. If null, the default is zero.

compare/less

Description

Compares if the left value is lesser than the right value. Commonly used operator in other programming languages: < Left and right operand as well as the boolean result are treated as vector. That is, one boolean result value is returned per each operand vector element. When comparing single elements, the vectors contain just one single value. Numbers may be given as vectors, for example the integer sequence "1,2,3". If using text operands, for example "Hello, World!", then the single characters are compared, one by one. Example with many elements: - operation: less - left: 10,2,3 - right: 1,2,3 - result: 0,1,1 (which corresponds to "false,true,true") Example with one single element: - operation: less - left: 33 - right: 3 - result: 0 (which corresponds to "false")

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value vector resulting from comparison.
left	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The left operand vector.
right	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The right operand vector.
count	false	text/cybol-path \| number/integer	The number of elements to be compared. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
left_index	false	text/cybol-path \| number/integer	The left index from where to start the comparison from. If null, the default is zero.
right_index	false	text/cybol-path \| number/integer	The right index from where to start the comparison from. If null, the default is zero.

compare/less-or-equal

Description

Compares if the left value is lesser than the right value or both are equal. Commonly used operator in other programming languages: <= Left and right operand as well as the boolean result are treated as vector. That is, one boolean result value is returned per each operand vector element. When comparing single elements, the vectors contain just one single value. Numbers may be given as vectors, for example the integer sequence "1,2,3". If using text operands, for example "Hello, World!", then the single characters are compared, one by one. Example with many elements: - operation: less-or-equal - left: 10,2,3 - right: 1,2,3 - result: 0,1,1 (which corresponds to "false,true,true") Example with one single element: - operation: less-or-equal - left: 33 - right: 3 - result: 0 (which corresponds to "false")

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value vector resulting from comparison.
left	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The left operand vector.
right	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The right operand vector.
count	false	text/cybol-path \| number/integer	The number of elements to be compared. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
left_index	false	text/cybol-path \| number/integer	The left index from where to start the comparison from. If null, the default is zero.
right_index	false	text/cybol-path \| number/integer	The right index from where to start the comparison from. If null, the default is zero.

compare/unequal

Description

Compares if left and right value are unequal. Commonly used operators in other programming languages: != <> Left and right operand as well as the boolean result are treated as vector. That is, one boolean result value is returned per each operand vector element. When comparing single elements, the vectors contain just one single value. Numbers may be given as vectors, for example the integer sequence "1,2,3". If using text operands, for example "Hello, World!", then the single characters are compared, one by one. Example with many elements: - operation: unequal - left: 10,2,3 - right: 1,2,3 - result: 0,1,1 (which corresponds to "false,true,true") Example with one single element: - operation: unequal - left: 33 - right: 3 - result: 0 (which corresponds to "false")

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean value vector resulting from comparison.
left	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The left operand vector.
right	true	text/cybol-path \| number/any \| text/plain \| element/part \| element/property	The right operand vector.
count	false	text/cybol-path \| number/integer	The number of elements to be compared. This is relevant only for arrays with more than one element. If null, the default is the lesser of left and right operand count.
left_index	false	text/cybol-path \| number/integer	The left index from where to start the comparison from. If null, the default is zero.
right_index	false	text/cybol-path \| number/integer	The right index from where to start the comparison from. If null, the default is zero.

contain/any

Description

Checks if the given part contains the value at all, no matter at which position. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean result flag indicating whether or not the part contains the value at all.
part	true	text/cybol-path	The part in which to search.
value	true	text/cybol-path \| text/plain \| number/integer	The value to search for.

contain/left

Description

Checks if the part starts with the given value, at the beginning. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean result flag indicating whether or not the part starts with the value.
part	true	text/cybol-path	The part in which to search.
value	true	text/cybol-path \| text/plain \| number/integer	The value to search for.

contain/right

Description

Checks if the part ends with the given value, at the end. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The boolean result flag indicating whether or not the part ends with the value.
part	true	text/cybol-path	The part in which to search.
value	true	text/cybol-path \| text/plain \| number/integer	The value to search for.

convert/decode

Description

Decodes the source into the destination, according to the encoding. Caution! The decoded data are appended to the destination. Already existing content is not overwritten. Therefore, the destination possibly has to get emptied before since otherwise, the new data will get appended to the already existing old data.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination wide character array consisting of elements of type
source	true	text/cybol-path	The source byte array consisting of elements of type
encoding	true	text/cybol-path \| meta/encoding	The message encoding.

convert/encode

Description

Encodes the source into the destination, according to the encoding. Caution! The encoded data are appended to the destination. Already existing content is not overwritten. Therefore, the destination possibly has to get emptied before since otherwise, the new data will get appended to the already existing old data.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination byte array consisting of elements of type
source	true	text/cybol-path	The source wide character array consisting of elements of type
encoding	true	text/cybol-path \| meta/encoding	The message encoding.

dispatch/close

Description

Closes down a client resource that has been used for connecting to a device or service on the given channel.

Examples

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
server	false	text/cybol-path \| logicvalue/boolean	The flag indicating server mode. It is used for example for a window or client socket stub. If null, the default is false (standalone client mode).
port	false	text/cybol-path \| number/integer	The service identification. It is relevant only in server mode. If null, the default is zero.
identification	true	text/cybol-path	The file descriptor or client socket number or window id returned from cyboi when opening the resource.

dispatch/open

Description

Opens up a client resource for connecting to a device or service on the given channel.

Examples

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
server	false	text/cybol-path \| logicvalue/boolean	The flag indicating server mode. It is used for example for a window or client socket stub. If null, the default is false (standalone client mode).
port	false	text/cybol-path \| number/integer	The service identification. It is relevant only in server mode. If null, the default is zero.
namespace	false	text/cybol-path \| text/plain	The address family. It is relevant only with channel socket. Example values: ipv4 or ipv6.
style	false	text/cybol-path \| text/plain	The communication style. It is relevant only with channel socket. Example values: stream or datagram.
protocol	false	text/cybol-path \| text/plain	The protocol. It is relevant only with channel socket. Example values: tcp or udp.
mode	false	text/cybol-path \| text/plain	The file open mode. Either read or write. If null, the default is read.
device	false	text/cybol-path \| text/plain	The filename for channel file or serial or terminal or fifo. Example values: /path/to/file.txt or /dev/ttyS0 or standard-output or standard-input or standard-error-output. The filename for channel socket with namespace local (unix domain socket). Example values: localbuffer.socket. The host address for channel socket with namespace ipv4 or ipv6. Example values: localhost or 127.0.0.1. It is null (not given) for channel display, since a client window does not need it.
identification	true	text/cybol-path	The file descriptor or client socket number or window id returned from cyboi when opening the resource.

feel/sense

Description

Starts sensing data input within a thread on the sender/client with the given identification. It fills the internal input buffer with those data that were received as input. Calling this operation is not necessary for channel "display" on a linux operating system with x window system, since "activate/enable" catches the events of all client windows. On a windows operating system, however, one separate event thread is run per window, so that calling "feel/sense" is necessary.

Examples

<node name="open_terminal_stdin" channel="inline" format="dispatch/open" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/>  <node name="device" channel="inline" format="text/plain" model="standard-input"/> <node name="identification" channel="inline" format="text/cybol-path" model=".var.stdin"/> </node> <node name="sense_terminal_input" channel="inline" format="feel/sense" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="sender" channel="inline" format="text/cybol-path" model=".var.stdin"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="handler" channel="inline" format="text/cybol-path" model=".logic.handle"/> </node> <node name="sense_data_on_serial_interface" channel="inline" format="feel/sense" model=""> <node name="channel" channel="inline" format="meta/channel" model="serial"/> <node name="sender" channel="inline" format="text/cybol-path" model=".serial_id"/> <node name="language" channel="inline" format="meta/language" model="message/binary-crlf"/> <node name="handler" channel="inline" format="text/cybol-path" model=".logic.handle"/> </node> <node name="sense_client_data_in_binary_format" channel="inline" format="feel/sense" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="port" channel="inline" format="number/integer" model="1971"/> <node name="sender" channel="inline" format="text/cybol-path" model=".client_socket"/> <node name="language" channel="inline" format="meta/language" model="message/binary-crlf"/> <node name="handler" channel="inline" format="text/cybol-path" model=".logic.handle_sense"/> <node name="closer" channel="inline" format="text/cybol-path" model=".logic.handle_close"/> </node> <node name="sense_client_data_as_http_request" channel="inline" format="feel/sense" model=""> <node name="channel" channel="inline" format="meta/channel" model="socket"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="port" channel="inline" format="number/integer" model="1971"/> <node name="sender" channel="inline" format="text/cybol-path" model=".var.client_socket"/> <node name="language" channel="inline" format="meta/language" model="message/http-request"/> <node name="handler" channel="inline" format="text/cybol-path" model=".logic.handle.sense"/> <node name="closer" channel="inline" format="text/cybol-path" model=".logic.handle.close"/> </node>  <node name="assign_handler_for_client_window_events" channel="inline" format="feel/sense" model=""> <node name="channel" channel="inline" format="meta/channel" model="display"/> <node name="server" channel="inline" format="logicvalue/boolean" model="true"/> <node name="sender" channel="inline" format="text/cybol-path" model=".gui.window_id"/> <node name="handler" channel="inline" format="text/cybol-path" model=".logic.handle"/> </node>

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
server	false	text/cybol-path \| logicvalue/boolean	The flag indicating server mode. It means server-side client stub and not standalone client. If null, the default is false (client mode).
port	false	text/cybol-path \| number/integer	The service identification. It is relevant only in server mode.
sender	true	text/cybol-path	The device identification, for example a file descriptor. Handing it over as hard-coded integer value does not make sense, since the operating system or server assigns it. Therefore, state a cybol-path.
language	false	text/cybol-path \| meta/language	The language used for deserialisation. It is also defining which prefix or suffix indicates the message length, for example binary-crlf, http-request, xdt.
handler	true	text/cybol-path	The callback cybol model to be executed when data were detected on the sender, in order to read them from the internal input buffer.
closer	false	text/cybol-path	The callback cybol model to be executed when the client does not respond and is to be closed.

feel/suspend

Description

Pauses data input sensing thread for the sender/client with the given identification.

Examples

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
server	false	text/cybol-path \| logicvalue/boolean	The flag indicating server mode. It means server-side client stub and not standalone client. If null, the default is false (client mode).
port	false	text/cybol-path \| number/integer	The service identification. It is relevant only in server mode.
sender	true	text/cybol-path	The device identification, for example a file descriptor. Handing it over as hard-coded integer value does not make sense, since the operating system or server assigns it. Therefore, state a cybol-path.

flow/branch

Description

Branches the programme flow, depending on the criterion flag.

Examples

<node name="branch_voltage" channel="inline" format="flow/branch" model=""> <node name="criterion" channel="inline" format="text/cybol-path" model=".settings.voltage_criterion"/> <node name="true" channel="file" format="element/part" model="indoor_climate/add_voltage.cybol"/> <node name="false" channel="file" format="element/part" model="indoor_climate/report_voltage_failure.cybol"/> </node>  <node name="if-then" channel="inline" format="flow/branch" model=""> <node name="criterion" channel="inline" format="text/cybol-path" model=".app.var.flag_loose"/> <node name="true" channel="inline" format="text/cybol-path" model=".app.print_win"/> </node>  <node name="if-then-else" channel="inline" format="flow/branch" model=""> <node name="criterion" channel="inline" format="text/cybol-path" model=".domain.flag"/> <node name="true" channel="inline" format="text/cybol-path" model=".domain.true_model"/> <node name="false" channel="inline" format="text/cybol-path" model=".domain.false_model"/> </node>  <node name="test_query" channel="inline" format="access/indicate-exists" model=""> <node name="result" channel="inline" format="text/cybol-path" model=".var.query_exists"/> <node name="part" channel="inline" format="text/cybol-path" model=".var.request:uri:query"/> </node> <node name="evaluate_query" channel="inline" format="flow/branch" model=""> <node name="criterion" channel="inline" format="text/cybol-path" model=".var.query_exists"/> <node name="true" channel="inline" format="text/cybol-path" model=".logic.evaluate_query"/>  <node name="false" channel="inline" format="text/cybol-path" model=".logic.send.empty_message"/> </node>  <node name="translate_cell" channel="inline" format="flow/branch" model=""> <node name="criterion" channel="inline" format="text/cybol-path" model="#empty"/> <node name="true" channel="inline" format="text/cybol-path" model=".logic.translate.db_to_wui.cell_default"/> <node name="false" channel="inline" format="text/cybol-path" model=".logic.translate.db_to_wui.cell"/> </node>  <node name="process_model_as_compound_or_primitive" channel="inline" format="flow/branch" model=""> <node name="criterion" channel="inline" format="text/cybol-path" model="#compound_flag"/> <node name="true" channel="inline" format="communicate/send" model=""> <node name="channel" channel="inline" format="meta/channel" model="terminal"/> <node name="receiver" channel="inline" format="text/cybol-path" model=".stdout"/> <node name="language" channel="inline" format="meta/language" model="message/tui"/> <node name="format" channel="inline" format="meta/format" model="text/plain"/> <node name="message" channel="inline" format="text/plain" model="Do nothing, since this is a compound model."/> </node> <node name="false" channel="inline" format="modify/overwrite" model=""> <node name="destination" channel="inline" format="text/cybol-path" model=".wui.index.body.content.(#wui_record_name).table.(#wui_field_name).model"/> <node name="source" channel="inline" format="text/cybol-path" model="#field_model_text"/> </node> </node>

Properties

Name	Required	Format	Description
criterion	true	text/cybol-path \| logicvalue/boolean	The flag defining which of the two models to execute.
true	false	text/cybol-path \| element/part	The logic knowledge model to be executed if the criterion is true.
false	false	text/cybol-path \| element/part	The logic knowledge model to be executed if the criterion is false.

flow/loop

Description

Loops the programme flow endlessly, until the break flag is set.

Examples

<node name="print_numbers" channel="inline" format="flow/loop" model=""> <node name="break" channel="inline" format="text/cybol-path" model=".break"/> <node name="model" channel="inline" format="text/cybol-path" model=".model"/> </node>  <node name="loop_rows" channel="inline" format="flow/loop" model=""> <node name="break" channel="inline" format="text/cybol-path" model="#row_break"/> <node name="model" channel="inline" format="text/cybol-path" model="#row_model"/> </node>  <node name="collect_voltages" channel="inline" format="flow/loop" model=""> <node name="break" channel="inline" format="text/cybol-path" model=".settings.adc_break"/> <node name="model" channel="file" format="element/part" model="adc/collect_voltages.cybol"/> </node>  <node name="loop_records" channel="inline" format="flow/loop" model=""> <node name="break" channel="inline" format="path/knowledge" model=".temporary.xdt.record.break"/> <node name="model" channel="inline" format="path/knowledge" model=".logic.translate.record"/> </node>  <node name="loop_page" channel="inline" format="flow/loop" model=""> <node name="break" channel="inline" format="text/cybol-path" model="#page_break"/> <node name="model" channel="inline" format="text/cybol-path" model=".logic.generate.page"/> </node>  <node name="generate_mines_in_game_minesweeper" channel="inline" format="flow/loop" model=""> <node name="break" channel="inline" format="text/cybol-path" model=".app.break"/> <node name="model" channel="inline" format="text/cybol-path" model=".app.logic.randomiser"/> </node>

Properties

Name	Required	Format	Description
break	true	text/cybol-path \| logicvalue/boolean	The break flag that causes the loop to be left.
model	true	text/cybol-path \| element/part	The logic knowledge model to be executed repeatedly by the loop.

flow/sequence

Description

Executes the given programme flow as sequence. This encapsulating operation "flow/sequence" is provided here to have all three constructs of structural programming implemented together, which are "sequence", "loop" and "branch". However, in principle, logic models may be executed standalone directly or with encapsulating operation "flow/sequence". Both kinds of execution are possible.

Examples

Properties

Name	Required	Format	Description
model	true	text/cybol-path \| element/part	The logic knowledge model to be executed as sequence.

live/exit

Description

Exits the cyboi system and closes the running application. Internally, an exit flag gets set so that the event loop gets left. Interrupt threads get exited, too. All objects in memory get deallocated. The cyboi interpreter finally exits.

Examples

logify/and

Description

Applies the boolean logic operation AND. y = x1 AND x2

Examples

Properties

Name	Required	Format	Description
output	true	text/cybol-path	The output resulting from the boolean logic operation. It initially represents the first input operand.
input	true	text/cybol-path \| logicvalue/boolean	The second input operand.

logify/nand

Description

Applies the boolean logic operation NAND. y = x1 NAND x2

Examples

Properties

Name	Required	Format	Description
output	true	text/cybol-path	The output resulting from the boolean logic operation. It initially represents the first input operand.
input	true	text/cybol-path \| logicvalue/boolean	The second input operand.

logify/neg

Description

Applies the boolean logic operation NEG. y = x1 NEG x2 When used with Bit operands, then this is the two's complement (all bits negated and added one).

Examples

Properties

Name	Required	Format	Description
output	true	text/cybol-path	The output resulting from the boolean logic operation. It initially represents the first input operand.
input	true	text/cybol-path \| logicvalue/boolean	The second input operand.

logify/nor

Description

Applies the boolean logic operation NOR. y = x1 NOR x2

Examples

Properties

Name	Required	Format	Description
output	true	text/cybol-path	The output resulting from the boolean logic operation. It initially represents the first input operand.
input	true	text/cybol-path \| logicvalue/boolean	The second input operand.

logify/not

Description

Applies the boolean logic operation NOT. y = x1 NOT x2 When used with Bit operands, then this is the one's complement (all bits negated).

Examples

Properties

Name	Required	Format	Description
output	true	text/cybol-path	The output resulting from the boolean logic operation. It initially represents the first input operand.
input	true	text/cybol-path \| logicvalue/boolean	The second input operand.

logify/or

Description

Applies the boolean logic operation OR. y = x1 OR x2

Examples

Properties

Name	Required	Format	Description
output	true	text/cybol-path	The output resulting from the boolean logic operation. It initially represents the first input operand.
input	true	text/cybol-path \| logicvalue/boolean	The second input operand.

logify/xnor

Description

Applies the boolean logic operation XNOR. y = x1 XNOR x2

Examples

Properties

Name	Required	Format	Description
output	true	text/cybol-path	The output resulting from the boolean logic operation. It initially represents the first input operand.
input	true	text/cybol-path \| logicvalue/boolean	The second input operand.

logify/xor

Description

Applies the boolean logic operation XOR. y = x1 XOR x2

Examples

Properties

Name	Required	Format	Description
output	true	text/cybol-path	The output resulting from the boolean logic operation. It initially represents the first input operand.
input	true	text/cybol-path \| logicvalue/boolean	The second input operand.

maintain/shutdown

Description

Shuts down the service running on the channel.

Examples

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
port	false	text/cybol-path \| number/integer	The service identification.

maintain/startup

Description

Starts up a service on the channel.

Examples

Properties

Name	Required	Format	Description
channel	true	text/cybol-path \| meta/channel	The communication channel.
port	false	text/cybol-path \| number/integer	The service identification.
namespace	false	text/cybol-path \| text/plain	The address family, for example local, ipv4, ipv6.
style	false	text/cybol-path \| text/plain	The communication style, for example stream, datagram, raw.
protocol	false	text/cybol-path \| text/plain	The protocol, for example tcp, udp, rdp.
device	false	text/cybol-path \| text/plain	The filename for channel socket with namespace local (unix domain socket). Example values: localbuffer.socket. The host address for channel socket with namespace ipv4 or ipv6. Example values: localhost or 127.0.0.1. It is null (not given) for channel display, since a client window does not need it.
connexions	false	text/cybol-path \| number/integer	The maximum number of possible pending client requests, for example 10.
timeout	false	text/cybol-path \| number/integer	The timeout in seconds set for each new client, for example 300.

manipulate/check

Description

Gets the bit at the given position. This bit manipulation operation corresponds to the "BT" (bit) or "BTST" (bit test) assembler command. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The bit at the given position of the value.
value	true	text/cybol-path	The value which is to be manipulated.
position	true	text/cybol-path \| number/integer	The bit position within the value.
count	false	text/cybol-path \| number/integer	The number of values to be manipulated. If null, the default is the value count.
index	false	text/cybol-path \| number/integer	The index from which to start manipulating values. If null, the default is zero.

manipulate/clear

Description

Resets the bit at the given position. This bit manipulation operation corresponds to the "BTR" (bit reset) assembler command. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
value	true	text/cybol-path	The value which is to be manipulated.
position	true	text/cybol-path \| number/integer	The bit position within the value.
count	false	text/cybol-path \| number/integer	The number of values to be manipulated. If null, the default is the value count.
index	false	text/cybol-path \| number/integer	The index from which to start manipulating values. If null, the default is zero.

manipulate/rotate-left

Description

Rotates all bits of the value to the left by the given position. This bit manipulation operation corresponds to the "ROL" (rotate left) assembler command. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
value	true	text/cybol-path	The value which is to be manipulated.
position	true	text/cybol-path \| number/integer	The bit position within the value.
count	false	text/cybol-path \| number/integer	The number of values to be manipulated. If null, the default is the value count.
index	false	text/cybol-path \| number/integer	The index from which to start manipulating values. If null, the default is zero.

manipulate/rotate-right

Description

Rotates all bits of the value to the right by the given position. This bit manipulation operation corresponds to the "ROR" (rotate right) assembler command. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
value	true	text/cybol-path	The value which is to be manipulated.
position	true	text/cybol-path \| number/integer	The bit position within the value.
count	false	text/cybol-path \| number/integer	The number of values to be manipulated. If null, the default is the value count.
index	false	text/cybol-path \| number/integer	The index from which to start manipulating values. If null, the default is zero.

manipulate/set

Description

Sets the bit at the given position. This bit manipulation operation corresponds to the "BTS" (bit set) assembler command. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
value	true	text/cybol-path	The value which is to be manipulated.
position	true	text/cybol-path \| number/integer	The bit position within the value.
count	false	text/cybol-path \| number/integer	The number of values to be manipulated. If null, the default is the value count.
index	false	text/cybol-path \| number/integer	The index from which to start manipulating values. If null, the default is zero.

manipulate/shift-left

Description

Shifts all bits of the value to the left by the given position. This bit manipulation operation corresponds to the "SHL" (shift left) assembler command. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
value	true	text/cybol-path	The value which is to be manipulated.
position	true	text/cybol-path \| number/integer	The bit position within the value.
count	false	text/cybol-path \| number/integer	The number of values to be manipulated. If null, the default is the value count.
index	false	text/cybol-path \| number/integer	The index from which to start manipulating values. If null, the default is zero.

manipulate/shift-right

Description

Shifts all bits of the value to the right by the given position. This bit manipulation operation corresponds to the "SHR" (shift right) assembler command. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
value	true	text/cybol-path	The value which is to be manipulated.
position	true	text/cybol-path \| number/integer	The bit position within the value.
count	false	text/cybol-path \| number/integer	The number of values to be manipulated. If null, the default is the value count.
index	false	text/cybol-path \| number/integer	The index from which to start manipulating values. If null, the default is zero.

manipulate/toggle

Description

Toggles the bit at the given position. This bit manipulation operation corresponds to the "CHG" (change) assembler command. TODO: NOT IMPLEMENTED YET!

Examples

Properties

Name	Required	Format	Description
value	true	text/cybol-path	The value which is to be manipulated.
position	true	text/cybol-path \| number/integer	The bit position within the value.
count	false	text/cybol-path \| number/integer	The number of values to be manipulated. If null, the default is the value count.
index	false	text/cybol-path \| number/integer	The index from which to start manipulating values. If null, the default is zero.

memorise/create

Description

Allocates an empty part in heap memory, consisting of name and type only. Each knowledge tree node has a double hierarchy with the main model branch representing the whole-part-structure and a second branch representing additional (mostly flat) properties. The "properties" property flag determines where to add the new part to. If the "whole" property is not given (null) and the "properties" flag set to true, then the new part gets added to the knowledge memory root node's properties branch.

Examples

Properties

Name	Required	Format	Description
name	true	text/cybol-path \| text/plain	The name of the part to be created.
format	true	text/cybol-path \| meta/format	The format of the part to be created. The internal data type gets determined from it.
whole	false	text/cybol-path	The destination parent node to which to add the new part to. If null, the default is the knowledge memory root node.
properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties branch as destination. If null, the default is false (model branch).

memorise/destroy

Description

Deallocates the given part in heap memory. Caution! Do not destroy the whole knowledge tree when shutting down a system since otherwise, the shutdown operation models of the corresponding cybol application being executed get destroyed as well, so that the exit operation cannot be executed anymore. The rubbish (garbage) collector cares about destruction evaluating references. The exit operation is the last one to be called. It cleans up all memory internally.

Examples

Properties

Name	Required	Format	Description
part	true	text/cybol-path	The part to be destroyed.

modify/append

Description

Appends the source data to the destination.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
move	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether or not to remove source elements after having been copied. If null, the default is false (deep copying). When deep copying elements (false), their whole sub tree gets cloned. With shallow copying (true), the element content does not get duplicated and only the memory pointers to the elements get copied and afterwards removed from the source container.
count	false	text/cybol-path \| number/integer	The number of elements to be copied. If null, the default is the source part model count.
source_index	false	text/cybol-path \| number/integer	The source index from which to start copying elements from. If null, the default is zero.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/empty

Description

Removes all data (elements) from the destination (container).

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).

modify/fill

Description

Fills the destination (container) with repeated source data (element). Caution! Even though the operations "modify/fill" and "modify/repeat" both copy a source element multiple times, there are differences between them. "modify/fill": - works with any element type - does not change the size of the destination container - overwrites existing elements until container is filled - can copy only one element (source count of one) "modify/repeat": - works only with text (character string) - adjusts the size of the destination container (grows or shrinks) - overwrites existing elements and may exceed the current destination container - can copy an element sequence (source count greater or equal to one)

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
source_index	false	text/cybol-path \| number/integer	The source index from which to start copying elements from. If null, the default is zero.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/insert

Description

Inserts the source data into the destination part at the destination index. Existing data behind the destination index (insertion position) get moved towards the end.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
move	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether or not to remove source elements after having been copied. If null, the default is false (deep copying). When deep copying elements (false), their whole sub tree gets cloned. With shallow copying (true), the element content does not get duplicated and only the memory pointers to the elements get copied and afterwards removed from the source container.
count	false	text/cybol-path \| number/integer	The number of elements to be copied. If null, the default is the source part model count.
destination_index	false	text/cybol-path \| number/integer	The destination index from which to start copying elements to. If null, the default is zero.
source_index	false	text/cybol-path \| number/integer	The source index from which to start copying elements from. If null, the default is zero.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/lower

Description

Converts the source string into lower case letters stored in the destination. The source and destination are permitted to point to the same part since the source gets buffered internally during processing. Caution! This operation is applicable to text only (string of characters). Caution! The destination length may differ from the source length since not all characters can be converted 1:1. The German "small letter sharp s" for example gets converted into the two capital letters "SS". Further reading: https://www.unicode.org/reports/tr21/tr21-5.html

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/normalise

Description

Removes leading and trailing whitespaces and additionally replaces all internal sequences of whitespace with just one. This is useful when parsing xml or html of a webpage, for example. Other than "modify/strip" this operation does also replace internal sequences of whitespace. The source and destination are permitted to point to the same part since the source gets buffered internally during processing. Caution! This operation is applicable to text only (character string). The considered whitespace characters are taken from the JSON specification: https://www.json.org/ They are: - empty: "" - space: 0020 - line feed: 000A - carriage return: 000D - character tabulation: 0009 The first (empty) can obviously not be considered and is just ignored.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/overwrite

Description

Overwrites the destination data with the source.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
move	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether or not to remove source elements after having been copied. If null, the default is false (deep copying). When deep copying elements (false), their whole sub tree gets cloned. With shallow copying (true), the element content does not get duplicated and only the memory pointers to the elements get copied and afterwards removed from the source container.
count	false	text/cybol-path \| number/integer	The number of elements to be copied. If null, the default is the source part model count.
destination_index	false	text/cybol-path \| number/integer	The destination index from which to start copying elements to. If null, the default is zero.
source_index	false	text/cybol-path \| number/integer	The source index from which to start copying elements from. If null, the default is zero.
adjust	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether or not the destination count shall be adjusted (true) to destination_index plus count. If null, the default is true (destination count will be adjusted). If false, the destination count remains as is and only gets extended, if the number of elements exceeds the destination count, in order to avoid memory errors caused by crossing array boundaries. Not adjusting the destination count makes sense for instance when overwriting only a few words in the middle of some text, in order to leave the trailing text untouched and the text length altogether as is.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/remove

Description

Removes count elements from the destination part.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
count	true	text/cybol-path \| number/integer	The number of elements to be removed. If null, the default is zero.
destination_index	false	text/cybol-path \| number/integer	The destination index from which to start removing elements. If null, the default is zero.
adjust	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether or not the destination count shall be adjusted (true) to destination_index plus count. If null, the default is true (destination count will be adjusted). If false, the destination count remains as is and only gets extended, if the number of elements exceeds the destination count, in order to avoid memory errors caused by crossing array boundaries. Not adjusting the destination count makes sense for instance when overwriting only a few words in the middle of some text, in order to leave the trailing text untouched and the text length altogether as is.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).

modify/repeat

Description

Writes the source repeatedly into the destination. The "number" property determines the number of times the source gets repeated. Caution! The "number" property must not be named or mixed up with "count", since the latter is used as container count and gets initialised with the source count. Caution! This operation is applicable to text only (character string). Caution! Even though the operations "modify/fill" and "modify/repeat" both copy a source element multiple times, there are differences between them. "modify/fill": - works with any element type - does not change the size of the destination container - overwrites existing elements until container is filled - can copy only one element (source count of one) "modify/repeat": - works only with text (character string) - adjusts the size of the destination container (grows or shrinks) - overwrites existing elements and may exceed the current destination container - can copy an element sequence (source count greater or equal to one)

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
repetition	true	text/cybol-path \| number/integer	The number of times the source gets repeated. If null, the default is zero.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/replace

Description

Replaces the searchterm character sequence within the destination by the source sequence as replacement. Caution! This operation is applicable to text only (character string).

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path \| text/plain	The source part. It is used as replacement sequence.
searchterm	true	text/cybol-path \| text/plain	The character sequence to be searched and replaced.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/reverse

Description

Reverses the order of elements in the destination part. Caution! This operation is applicable to text only (character string).

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).

modify/strip

Description

Removes leading and trailing whitespaces. Some programming languages and frameworks use the synonym name "trim" instead of "strip". Other than "modify/normalise" this operation does not replace internal sequences of whitespace. The source and destination are permitted to point to the same part since the source gets buffered internally during processing. Caution! This operation is applicable to text only (character string). The considered whitespace characters are taken from the JSON specification: https://www.json.org/ They are: - empty: "" - space: 0020 - line feed: 000A - carriage return: 000D - character tabulation: 0009 The first (empty) can obviously not be considered and is just ignored.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/strip-leading

Description

Removes leading whitespaces. Some programming languages and frameworks use the synonym name "trim" instead of "strip". Other than "modify/strip" this operation does not replace trailing whitespaces. The source and destination are permitted to point to the same part since the source gets buffered internally during processing. Caution! This operation is applicable to text only (character string). The considered whitespace characters are taken from the JSON specification: https://www.json.org/ They are: - empty: "" - space: 0020 - line feed: 000A - carriage return: 000D - character tabulation: 0009 The first (empty) can obviously not be considered and is just ignored.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/strip-trailing

Description

Removes trailing whitespaces. Some programming languages and frameworks use the synonym name "trim" instead of "strip". Other than "modify/strip" this operation does not replace leading whitespaces. The source and destination are permitted to point to the same part since the source gets buffered internally during processing. Caution! This operation is applicable to text only (character string). The considered whitespace characters are taken from the JSON specification: https://www.json.org/ They are: - empty: "" - space: 0020 - line feed: 000A - carriage return: 000D - character tabulation: 0009 The first (empty) can obviously not be considered and is just ignored.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

modify/upper

Description

Converts the source string into upper case letters stored in the destination. The source and destination are permitted to point to the same part since the source gets buffered internally during processing. Caution! This operation is applicable to text only (string of characters). Caution! The destination length may differ from the source length since not all characters can be converted 1:1. The German "small letter sharp s" for example gets converted into the two capital letters "SS". Further reading: https://www.unicode.org/reports/tr21/tr21-5.html

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The destination part.
source	true	text/cybol-path	The source part.
destination_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as destination. If null, the default is false (model).
source_properties	false	text/cybol-path \| logicvalue/boolean	The flag indicating whether to use the model or properties container as source. If null, the default is false (model).

randomise/retrieve

Description

Retrieves the next pseudo-random number in the series. Caution! If calling "randomise/retrieve" before a seed has been established with "randomise/sow", the value of 1 is used as default seed inside glibc.

Examples

Properties

Name	Required	Format	Description
result	true	text/cybol-path	The pseudo-random value delivered by the system.
minimum	false	text/cybol-path \| number/integer	The lower bound (inclusive) of the value to be generated. If null, the default is zero.
maximum	false	text/cybol-path \| number/integer	The upper bound (exclusive) of the value to be generated. If null, the default is RAND_MAX. The GNU C Library's RAND_MAX value 2147483647 is the largest signed integer representable in 32 bits.

randomise/sow

Description

Sows a seed for a new series of pseudo-random numbers.

Examples

Properties

Name	Required	Format	Description
seed	true	text/cybol-path \| number/integer	The source seed to be established for a new series of pseudo-random numbers.

represent/deserialise

Description

Deserialises the source into the destination, according to the given format. Caution! The deserialised data are appended to the destination. Already existing content is not overwritten. Therefore, the destination possibly has to get emptied before since otherwise, the new data will get appended to the already existing old data. This operation may be used to split a source string into parts which are stored as child nodes of the destination part.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The node into which the deserialised data are written. Its format (type) depends on the given source data.
source	true	text/cybol-path \| text/plain	The data to be deserialised.
language	true	meta/language	The language used for deserialisation.
format	false	meta/format	The format (type) of the source node.

Constraints (language_constraints)

Name	Required	Format	Description
decimal_separator	false	text/plain	The symbol (or character sequence) used to separate the integer part from the fractional part of a floating point (decimal) number.
thousands_separator	false	text/plain	The symbol (or character sequence) used for digit grouping.
delimiter	false	text/plain	The separator between the single fields (values). It may consist of many characters, but also be a simple comma, for example. Used with joined strings or character (comma) separated values (csv).
quotation	false	text/plain	The marker sequence used at the beginning and end of string fields (values). It may consist of many characters. Quotation is necessary if the delimiter character is part of the value. If the quotation is to be part of the value, then it has to be escaped by writing it twice (doubled). Used with joined strings or character (comma) separated values (csv).
header	false	logicvalue/boolean	The flag indicating whether or not the source data contain a header, so that the deserialiser can treat the first line differently. Used with character (comma) separated values (csv). Caution! It should not be mixed up with the headermodel property in represent/serialise.
normalisation	false	logicvalue/boolean	The flag indicating whether or not whitespaces and line breaks are merged into just one space. Used with xml or html, for example. If null, then the default is true (normalisation enabled).
maximum	false	number/integer	The maximum number of bytes to be transmitted. Used with serial (port) interface.
minimum	false	number/integer	The minimum number of bytes to be transmitted. Used with serial (port) interface.
medium	false	text/cybol-path	The window to which the mouse button or keyboard key refers. It is needed to search through the hierarchy of gui elements via mouse coordinates, for a suitable action. Used with graphical user interface (gui).

represent/serialise

Description

Serialises the source into the destination, according to the given format. Caution! The serialised data are appended to the destination. Already existing content is not overwritten. Therefore, the destination possibly has to get emptied before since otherwise, the new data will get appended to the already existing old data. This operation may be used to concatenate the strings given as child nodes of the source part into the destination part and provide an optional cybol property "separator" to be used as such between the concatenated strings.

Examples

Properties

Name	Required	Format	Description
destination	true	text/cybol-path	The node into which the serialised data are written. Its format (type) depends on the given source data.
source	true	text/cybol-path \| text/plain \| number/any	The data to be serialised.
language	true	meta/language	The language used for serialisation.
format	false	meta/format	The format (type) of the source node.

Constraints (language_constraints)

Name	Required	Format	Description
sign	false	logicvalue/boolean	The flag indicating whether or not a plus sign is to be displayed for positive numbers. Negative numbers have a minus sign in any case. If null, the default is false (no plus sign for positive numbers).
base	false	number/integer	The number base for example 2 for binary (dual), 8 for octal, 10 for decimal, 16 for hexadecimal. If null, the default is 10 (decimal number base).
classicoctal	false	logicvalue/boolean	The flag indicating whether or not the octal number base prefix is to be displayed as 0 as in classic c/c++ or using modern style 0o as in perl and python. If null, the default is false (modern style with prefix 0o).
grouping	false	text/plain	The symbol or character sequence used for digit grouping in thousands. If null, the default is not to use any thousands separator at all.
separator	false	text/plain	The symbol or character sequence used to separate the integer part from the fractional part of a floating point decimal number. If null, the default is to use the full stop (dot).
decimals	false	number/integer	The number of post-point decimal places (decimals). If null, the default is 4.
scientific	false	logicvalue/boolean	The flag indicating whether or not the decimal fraction gets displayed with mantissa and exponent. If null, the default is false (standard representation without exponent).
polar	false	logicvalue/boolean	The flag indicating whether or not to write the complex number using polar coordinates. If null, the default is false (using the cartesian form).
newline	false	logicvalue/boolean	The flag indicating whether or not a line break is added at the end of the printed characters. If null, the default is true (line gets broken). Used with text (pseudo) terminal.
clear	false	logicvalue/boolean	The flag indicating whether or not the terminal screen is cleared before printing characters on it. If null, the default is false (no clearing). Used with text (pseudo) terminal.
positioning	false	logicvalue/boolean	The flag indicating whether or not the cursor position may get changed. If null, the default is false (no repositioning). Used with text (pseudo) terminal.
indentation	false	logicvalue/boolean	The flag indicating whether or not the serialised data get beautified (pretty-formatted) by indenting the single lines depending on the hierarchy level. Used with xml or html, for example.
delimiter	false	text/plain	The separator between the single fields (values). It may consist of many characters, but also be a simple comma, for example. Used with joined strings or character (comma) separated values (csv).
quotation	false	text/plain	The marker sequence used at the beginning and end of string fields (values). It may consist of many characters. Quotation is necessary if the delimiter character is part of the value. If the quotation is to be part of the value, then it has to be escaped by writing it twice (doubled). Used with joined strings or character (comma) separated values (csv).
normalisation	false	logicvalue/boolean	The flag indicating whether or not whitespaces and line breaks are merged into just one space. Used with xml or html, for example. If null, then the default is true (normalisation enabled).
width	false	number/integer	The number of characters (or digits) belonging to a value. Free places get filled up with the character given in the fill property. This was defined in the original specification of character (comma) separated values (csv), in order to have fields (values) with equal width. Used with joined strings or csv.
fill	false	text/plain	The characters (or digit) to be used to fill free places in a value whose width is greater.
headermodel	false	text/cybol-path	The header data to be written as first line, yet before the actual content. Used with character (comma) separated values (csv). Caution! It should not be mixed up with the header property flag in represent/deserialise or communicate/receive.

run/run

Description

Executes a local programme.

Examples

Properties

Name	Required	Format	Description
programme	true	text/cybol-path	The programme to be executed.

run/sleep-nano

Description

Puts the executing thread to sleep for at least x nanoseconds. Caution! The actual duration may differ depending on the system's load and timer accuracy.

Examples

Properties

Name	Required	Format	Description
duration	true	text/cybol-path \| number/integer	The time as amount of nanoseconds to sleep.

run/sleep-second

Description

Puts the executing thread to sleep for at least x seconds. Caution! The actual duration may differ depending on the system's load and timer accuracy.

Examples

Properties

Name	Required	Format	Description
duration	true	text/cybol-path \| number/integer	The time as amount of seconds to sleep.

search/binary

Description

Finds the first occurrence of the specified searchword within the sorted list using binary (half-interval, logarithmic, binary chop) search. Returns the index of the searchword as result; leaves the index untouched otherwise. Caution! The list must be sorted first to be able to apply binary search. TODO: NOT IMPLEMENTED YET!

Examples

See section "search/interpolation"!

search/interpolation

Description

Finds the first occurrence of the specified searchword within the sorted list using interpolation binary search. Returns the index of the searchword as result; leaves the index untouched otherwise. Caution! The list must be sorted first to be able to apply interpolation binary search. TODO: NOT IMPLEMENTED YET!

Description

This is pure text data, sometimes called "string" or "character array". Common file suffixes are: txt The text may be encoded in various ways, which is specified in a different property called "encoding". It is usually given when using the cybol operations send or receive.

Examples

text/xml

Description

Data given in XML format. The Extensible Markup Language (XML) version 1.0 was defined in 1998. Its structure and vocabulary can be defined freely, either as Document Type Definition (DTD) or as XML Schema Definition (XSD). Common file suffixes are: xml If given in form of a file, then the suffix is "xml" in case no DTD or XSD is available. Otherwise, another suffix representing the DTD or XSD may be used. There are two MIME assignments for XML data: - application/xml (RFC 7303, previously RFC 3023) - text/xml (RFC 7303, previously RFC 3023) However, since the introduction of RFC 7303, these are to be regarded as the same in all aspects except name.

Examples

video/mp4

Description

A video in MP4 format, which is defined in RFC 4337. The file suffix is mp4.

Examples