defs/si_sha/autodev.h File Reference

A base representation of automation devices in LASE. More...

#include <si_std/string.h>
#include <si_std/listt.h>
#include <si_std/ptrh.h>

Go to the source code of this file.

Classes

struct  sc_automationDevice
 A base representation of all devices in LASE. More...

Typedefs

typedef struct
sc_automationBridgeDevice 
sc_automationBridgeDevice

Functions

sc_status sc_automationDevice_construct (sc_automationDevice *pd, const TCHAR *name, const TCHAR *type, const TCHAR *addr, const TCHAR *netType)
sc_status sc_automationDevice_destruct (sc_automationDevice *pd)
 sm_ptrhDecl (sc_automationDevice)
 Macro declared sc_automationDevicePtrh: device pointer-handles.
sc_status sc_automationDevice_new (const TCHAR *name, const TCHAR *type, const TCHAR *addr, const TCHAR *ntyp, sc_automationDevicePtrh *ptrh)


Detailed Description

A base representation of automation devices in LASE.

All devices in LASE must have a name, address, type, and netType. If some devices lack such standards, they can be assigned by LASE.


Function Documentation

sc_status sc_automationDevice_construct ( sc_automationDevice pd,
const TCHAR *  name,
const TCHAR *  type,
const TCHAR *  addr,
const TCHAR *  netType 
)

Constructs a device with the given name, type, address and network type.

Parameters:
[in,out] pd Device object to construct.
[in] name The identifier the device uses.
[in] type The device type.
[in] addr The address of the device on its network.
[in] netType The network type the device is connected to.

sc_status sc_automationDevice_destruct ( sc_automationDevice pd  ) 

Destructs the device base class.

sc_status sc_automationDevice_new ( const TCHAR *  name,
const TCHAR *  type,
const TCHAR *  addr,
const TCHAR *  ntyp,
sc_automationDevicePtrh *  ptrh 
)

Creates a new base device and returns it in ptrh.

See also:
sc_automationDevice_construct


doxygen