4.5.3. Master-Side Libraries

The following libraries are included with the Fluent as a Server SDK and are used to communicate between the IronPython Master running in Workbench or Simplorer and the Fluent and OLGA clients.

4.5.3.1. Fluent as a Server DLL

In order to communicate with a running Fluent as a Server session from the IronPython Master, it is necessary to load one of the pre-built .NET DLLs supplied with the Fluent as a Server SDK. Refer to Using the Pre-Built .NET Connector for additional information about the Fluent as a Server interfaces and the available DLLs.

4.5.3.2. OLGA OPC Connector DLL

IronPython clients running in either ANSYS Workbench or ANSYS Simplorer connect to the OLGA OPC Connector through classes and methods defined in the file DotNetCoOpcUnit.dll and structures defined in AasCoOpcUnit.dll.

4.5.3.2.1. Libraries

DotNetCoOpcUnit.dll

public class DotNetCoOpcServer
public DotNetCoOpcServer();

constructor for DotNetCoOpcServer objects

public void ConnectToServerFromIorFile(string p_stringIorFile);

connect to the remote OLGA OPC server with OLGA aaS key p_stringIorFile

public string getStatusReport();

returns a status report from OLGA

public DotNetOPCItemMgmt AddGroup(string p_stringGroupName);

create an OPC group named p_stringGroupName

public void RemoveGroup(DotNetOPCItemMgt p_dot_netOPCItemMgt);

remove the OPC group named p_dot_netOPCItemMgt

public DotNetOlgaBrowseServerCommands getOLGABrowseServerCommands();

retrieve a browser of OLGA commands

public DotNetOLGACommandProperties getOLGACommandProperties();

retrieve a browser of OLGA command properties

public DotNetOPCItemProperties getOPCItemProperties();

retrieve a browser of OPC item properties

public DotNetOPCBrowseServerAddressSpace getOPCBrowseServerAddressSpace();

retrieve a browser of OPC Server address space

public class DotNetOPCBrowseServerAddressSpace
public string[] BrowseOPCItemIDs();

retrieve OPC item IDs from OLGA

public class DotNetOlgaBrowseServerCommands
public string[] BrowseCommandIDs();

retrieve a list of OLGA command IDs

public class DotNetOLGACommandProperties
string GetCommandPropertiesReport(string p_stringCommandID);

retrieve a command properties report for the OLGA command p_stringCommandID

public class DotNetOPCItemProperties
public string GetItemPropertiesReport(string p_stringItemID);

retrieve an item properties report for the OPC item p_stringItemID

public class DotNetOPCItemMgt
public AAS_CORBA.OPC.IOItem AddItem(string p_stringItemName);

add the OPC item p_stringItemName to an OPC group

public DotNetIOPCSyncIO GetIOPCSyncIO();

retrieve a synchronous access object

public class DotNetIOPCSyncIO
bool ReadItemAsBool(int p_iOPCHandle);
void WriteItemAsBool(int p_iOPCHandle, int p_iComType, bool p_Value);
bool[] ReadItemAsBoolArray(int p_iOPCHandle);
void WriteItemAsBoolArray(int p_iOPCHandle, int p_iComType, bool[] p_aValues);
double ReadItemAsDouble(int p_iOPCHandle);
void WriteItemAsDouble(int p_iOPCHandle, int p_iComType, double p_Value);
double[] ReadItemAsBoolArray(int p_iOPCHandle);
void WriteItemAsDoubleArray(int p_iOPCHandle, int p_iComType, double[] p_aValues);
int ReadItemAsLong(int p_iOPCHandle);
void WriteItemAsLong(int p_iOPCHandle, int p_iComType, int p_Value);
int[] ReadItemAsLongArray(int p_iOPCHandle);
void WriteItemAsLongArray(int p_iOPCHandle, int p_iComType, int[] p_aValues);
string ReadItemAsString(int p_iOPCHandle);
void WriteItemAsString(int p_iOPCHandle, int p_iComType, string p_Value);
string[] ReadItemAsStringArray(int p_iOPCHandle);
void WriteItemAsStringArray(int p_iOPCHandle, int p_iComType, string[] p_aValues);
string ReadStringifiedItem(int p_iOPCHandle);
void WriteStringifiedItem(int p_iOPCHandle, int p_iComType, string p_Value);

AasCoOpcUnit.dll

struct ICoOpcUnitError

Structure for exceptions returned from the OPC connection to OLGA

long m_iCode;
long m_stringDescription;
long m_stringInterfaceName;
long m_stringMoreInfo;
long m_stringName;
long m_stringOperation;
long m_stringScope;
struct IOItem

Structure for items in OLGA. To add items, see public AAS_CORBA.OPC.IOItem AddItem(string p_stringItemName);. To read/write items, see public class DotNetIOPCSyncIO.

long m_iCOMType
long m_iOPCHandle
string m_stringItemId

Release 18.2 - © ANSYS, Inc. All rights reserved.