VCSSL/VNANO PLUGIN INTERFACE SPECIFICATION

Bool Scalar Data Accessor Interface 1 (Bool SDAI1)
Specification Document
(org.vcssl.connect.BoolScalarDataAccessorInterface1)


Abstract

Bool Scalar Data Accessor Interface 1 (Bool SDAI1) is a data-I/O interface, mainly implemented by data container objects of language processor systems.

In this org.vcssl.connect package, multiple data I/O interfaces are provided for passing/receiving data without any data-conversions, between script-engine-side and plug-in-side, if required.

In them, this interface Bool SDAI1 provides I/O methods of a boolean-type scalar value.

Status

The status of this interface is "FINALIZED".

The specification of this interface had been finalized at 2022/08/31. No modifications will be applied for this interface, excluding documents/comments.

This interface is currently supported by the scripting engine of Vnano. You can use this interface for development of plug-ins of applications equipped with the Vnano engine.

License

This interface is published under CC0, which is almost the same as the so-called "copyright-free" (domain).

List of Fields/Methods

INTERFACE_TYPE_ID
The type ID of this interface (value: "BOOL_SDAI") referred when the plug-in will be loaded.
INTERFACE_GENERATION
The generation of this interface (value: "1").
void setBoolScalarData(boolean data)
Sets the boolean-type scalar value.
boolean getBoolScalarData()
Gets the boolean-type scalar value.
boolean hasBoolScalarData()
Returns whether any boolean-type scalar value can be gotten.

Fields

Name INTERFACE_TYPE_ID
Value The type ID of this interface (value: "BOOL_SDAI") referred when the plug-in will be loaded.
Type static final String
Name INTERFACE_GENERATION
Value The generation of this interface (value: "1").
Type static final String

Methods

Name setBoolScalarData
Signature void setBoolScalarData(boolean data)
Description Sets the boolean-type scalar value.
Parameters data: The scalar value to be set.
Return None
Name getBoolScalarData
Signature boolean getBoolScalarData()
Description Gets the boolean-type scalar value.
Parameters None
Return The scalar value.
Name hasBoolScalarData
Signature boolean hasBoolScalarData()
Description Returns whether any boolean-type scalar value can be gotten.
Parameters None
Return Returns true if any boolean-type scalar value can be gotton.