ReadASAMODS (FPScript)

21.09.2021

Reads ASAM ODS (Open Data Services) data.

Syntax

ReadASAMODS(Connection, ASAMPath, Attribute)

 

The syntax of the ReadASAMODS function consists of the following parts:

Part

Description

Connection

A string is used that can be used for establishing a connection to an ASAM ODS server. The string consists of multiple parameters separated by a semicolon.

CONNECTION specifies the connection type. Valid values are CORBA, ATF and ATFX.

PATH specifies the path of the ATF or ATFX file.

SERVER specifies the name of the machine hosting the ASAM ODS server.

PORT specifies the port of the ASAM ODS server.

FACTORYNAME specifies the factory name. Each ASAM ODS server available on the network and registered with an ORB provides what is called a factory interface and lets clients obtain general information about the server and connect to the server. The factory interface is clearly described by its name and type.

FACTORYTYPE specifies the factory type.

USER specifies the user.

PASSWORD specifies the user password.

Permitted data structures are scalar value. Supported data types are string.

If the argument is a list, then the function is executed for each element of the list and the result is also a list.

ASAMPath

The ASAM path used to address an instance element. For ATF and ATFX files, the path is a combination of the name of the application element from which the instance element was derived and the instance element ID.

Permitted data structures are scalar value. Supported data types are string.

If the argument is a list, then the function is executed for each element of the list and the result is also a list.

Attribute

The name of the attribute to be read from the instance element.

Permitted data structures are scalar value. Supported data types are string.

If the argument is a list, then the first element in the list is taken. If this is also a list, then the process is repeated.

Remarks

The result provided by the function is the value of the attribute located in the instance element addressed by the ASAM path.

Available in

Option ASAM ODS Import

Examples

ReadASAMODS("CONNECTION = ATF; PATH = C:\\ASAM\\ASAM ATF\\database.atf", "[localcolumn]1", "values")

Reads the value of the attribute values from an ATF file, which is located in the instance element with the path [localcolumn]1.

ReadASAMODS("CONNECTION = CORBA;" : _
"SERVER = 192.168.1.27;" : _
"PORT = 1049;" : _
"FACTORYNAME = openaos;" : _
"FACTORYTYPE = ASAM-ODS;" : _
"USER = openaos;" : _
"PASSWORD = openaos", _
"/[Environment]MyEnvironment/[Test]MyTest", "Name")

Reads the value of the attribute values via the CORBA interface from an ASAM ODS server.

See Also

ASAM ODS Data Import Option

File Import

Share article or send as email:

You might be interested in these articles