IContainer Interface Reference

Inherits IDispatch.

Collaboration diagram for IContainer:

Classes
struct	ContainerInformation
struct	ContainerItemInformation

Public Types

Properties
IReadContainers	Read [get]
IWriteContainers	Write [get]

Detailed Description

Definition of the IContainer interface which can be used to establish a fast data exchange of grouped data elements.

Use the containers when you need to access a larger set of data repetitively and with maximum update speed. For example, input data you want to read every machine cycle. Using the Read or Write Container, you first have to create a container by naming all the elements you want to read with the container. This also defines the memory layout of the container. After that you can read/write your data using the Update function of the IReadContainer respectively the IWriteContainer.

Definition at line 75 of file IContainer.idl.

Member Enumeration Documentation

enum IContainer::ContainerAccess

This enumeration defines whether we have a READ or WRITE container.

Enumerator
CONTAINER_ACCESS_READ	Enumeration for read container.
CONTAINER_ACCESS_WRITE	Enumeration for write container.

Definition at line 80 of file IContainer.idl.

Property Documentation

IReadContainers IContainer::Read

get

This property returns a IReadContainers object which allows access to different IReadContainer objects.

Note

If the container with the given name does not exist, then it will be created. The IReadContainers interface is a collection interface.

Parameters

[out]

readContainer

Returns an object of the type IReadContainers.

Returns

Return value indicating success (>=0) or error (<0).

Example C#:

try
{
  // let's get a read container object with the name "MyCustomReadContainer1".
  IReadContainer container = connection.Container.Read["MyCustomReadContainer1"];

  // use buffer object to print name of the buffer
  Console.WriteLine("ContainerName: " + container.GetName());
}
catch (System.Exception ex)
{
  Console.WriteLine("Error: " + ex.Message);
}

IWriteContainers IContainer::Write

get

This property returns a IWriteContainers object which allows access to different IWriteContainer objects.

Note

If the container with the given name does not exist, then it will be created. The IWriteContainers interface is a collection interface.

Parameters

[out]

writeContainer

Returns an object of the type IWriteContainers.

Returns

Return value indicating success (>=0) or error (<0).

Example C#:

try
{
  // let's get a write container object with the name "MyCustomWriteContainer1".
  IWriteContainer container = connection.Container.Write["MyCustomWriteContainer1"];

  // use buffer object to print name of the buffer
  Console.WriteLine("ContainerName: " + container.GetName());
}
catch (System.Exception ex)
{
  Console.WriteLine("Error: " + ex.Message);
}

---

The documentation for this interface was generated from the following file:

• IContainer.idl