SIMATIC S7 MatLab Toolbox
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
PlcArray Class Reference

Represents an abstract base class of PLC arrays. More...

Inheritance diagram for PlcArray:
PlcValue PlcBooleanArray PlcByteArray PlcCharArray PlcDoubleArray PlcInt16Array PlcInt32Array PlcRealArray PlcUInt16Array PlcUInt32Array

Public Member Functions

function get Length (in this)
 Gets a 32-bit integer that represents the total number of elements within the array.
 
- Public Member Functions inherited from PlcValue
function get Address (in this)
 Gets the address of the PLC value.
 
function GetValue (in this, in source)
 Retrieves the current value of the PLC value from the source specified. More...
 
function IsValidType (in this, in value)
 Determines whether a specified value is acceptable for this PlcValue. More...
 
function IsValidValue (in this, in value)
 Determines whether the provided value is accepted for the type of PLC value through basic type checking and also potentially if it is within the allowed range of value for that type. More...
 
function SetValue (in this, in target, in value)
 Stores the value in the target specified. More...
 

Public Attributes

Property Length
 Gets a 32-bit integer that represents the total number of elements within the array. A 32-bit integer that represents the total number of elements within the array.
 
- Public Attributes inherited from PlcValue
Property Address
 Gets the address of the PLC value. The PlcAddress used by the PLC value.
 
Property Value
 Gets or sets the value assigned to the PLC value. The value assigned to the PLC value.
 
Property ManagedInstance
 This property is not intended to be used outside of the toolbox.
 

Protected Member Functions

function PlcArray (in typeCode, in address, in values)
 Initializes a new instance of the PlcArray class using the specified typeCode, address and values. More...
 
- Protected Member Functions inherited from PlcValue
function PlcValue (in typeCode, in address, in length, in value)
 Initializes a new instance of the PlcValue class. More...
 

Detailed Description

Represents an abstract base class of PLC arrays.

Constructor & Destructor Documentation

◆ PlcArray()

function PlcArray::PlcArray ( in  typeCode,
in  address,
in  values 
)
protected

Initializes a new instance of the PlcArray class using the specified typeCode, address and values.

Parameters
typeCodeOne of the members defined by the PlcTypeCode enumeration class which defines the concrete type of values represented.
addressThe PlcAddress of the new PlcArray to which the PLC
values belong.
valuesThe initial values of the new PlcArray.

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