Book Creator
 Add this page to your book
Book Creator
 Remove this page from your book  

 Manage book (0 page(s))
 Help

PlcStringType Members

Namespace: IPS7Lnk.Advanced
Assemblies: IPS7LnkNet.Advanced.dll, IPS7LnkNet.Advanced.dll
The PlcStringType type exposes the following members.

Fields

MaxLength

Specifies the maximum value that can be used for a PlcStringType.

C# 

public const int MaxLength = 254


Field Value
Int32

MinLength

Specifies the minimum value that can be used for a PlcStringType property.

C# 

public const int MinLength = 0


Field Value
Int32

Properties

DefaultValue

Gets the type dependent default value which can be assigned to an entity of the type represented.

C# 

public override object DefaultValue { get; }


Property Value

Object

The type dependent default value.

Methods

CreateEntity()

Creates a new IPlcEntity object which represents a concrete accessible entity of this PlcType.

C# 

public override IPlcEntity CreateEntity()


Returns

IPlcEntity

An instance implementing the IPlcEntity interface its Type property does refer to this PlcType.



Exceptions

NotSupportedException

This pure PlcType instance can't create an entity, because it is an abstract type representation.

Of(Int32)

Retrieves the according PlcStringType which matches the supplied type metadata.

C# 

public static PlcStringType Of(int length)


Parameters

length Int32

The maximum length used to store a PlcStringType value.


Returns

PlcStringType

The PlcStringType which matches with the characteristics supplied.



Exceptions

ArgumentOutOfRangeException

The length is out of the bounds defined by MinLength and MaxLength.

Of(PlcIdentity, Int32)

Retrieves the according PlcStringType which matches the supplied type metadata.

C# 

public static PlcStringType Of(PlcIdentity identity, int length)


Parameters

identity PlcIdentity

The PlcIdentity to which the PlcStringType does refer.

length Int32

The maximum length used to store a PlcStringType value.


Returns

PlcStringType

The PlcStringType which matches with the characteristics supplied.



Exceptions

ArgumentException

The identity does not provide the necessary information required to address the type of data.

ArgumentNullException

The identity is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

The length is out of the bounds defined by MinLength and MaxLength.

Of(PlcIdentity, PlcName, Int32)

Retrieves the according PlcStringType which matches the supplied type metadata.

C# 

public static PlcStringType Of(PlcIdentity identity, PlcName name, int length)


Parameters

identity PlcIdentity

The PlcIdentity to which the PlcStringType does refer.

name PlcName

The PlcName of the PlcType.

length Int32

The maximum length used to store a PlcStringType value.


Returns

PlcStringType

The PlcStringType which matches with the characteristics supplied.



Exceptions

ArgumentException

The identity does not provide the necessary information required to address the type of data.

ArgumentNullException

The identity or name is a null reference (Nothing in Visual Basic).

ArgumentOutOfRangeException

The length is out of the bounds defined by MinLength and MaxLength.