Namespace: IPS7Lnk.Advanced
Assemblies: IPS7LnkNet.Advanced.dll, IPS7LnkNet.Advanced.dll
The PlcType type exposes the following members.
Gets the start address of the PlcType in the PLC.
C#
public PlcAddress Address { get; }
Property Value
The PlcAddress used as the start address of the PlcType at which data of the type represented is stored within the PLC.
Remarks
The value of this property is a null reference (Nothing in Visual Basic) in cases there the PlcType is relative (see IsAbsolute).
Gets the type dependent default value which can be assigned to an entity of the type represented.
C#
public virtual object DefaultValue { get; }
Property Value
The type dependent default value.
Gets the end address of the PlcType in the PLC.
C#
public PlcAddress EndAddress { get; }
Property Value
The PlcAddress used as the end address of the PlcType at which the data associated with the type represented ends within the PLC.
Remarks
The value of this property is a null reference (Nothing in Visual Basic) in cases there the PlcType is relative (see IsAbsolute).
The PlcAddress provided by this property does represent the inclusive address of the type represented.
Gets the identity of the PlcType in the PLC.
C#
public PlcIdentity Identity { get; }
Property Value
The PlcIdentity used to identify the PLC resource associated with the PlcType.
Gets a value indicating whether the PlcType does absolutely refer to a PLC resource.
C#
public bool IsAbsolute { get; }
Property Value
The value true, if the PlcType does refer by its Identity to a absolute PLC resource; otherwise the value false.
Remarks
If Address isn't a null reference (Nothing in Visual Basic) in general IsAbsolute will always return the value true. In cases there the Identity is an instance of the PlcOperand class the property will return also the value true if the Type is equals DataBlock.
Gets the characteristics to use when aligning the Members of the PlcType.
C#
public PlcTypeLayout Layout { get; }
Property Value
An instance of the PlcTypeLayout class to align the Members.
Gets a 32-bit integer that represents the total number of elements that can be stored in a value of the type.
C#
public int Length { get; }
Property Value
A 32-bit integer that represents the total number of elements that can be stored in a value of the type.
Gets the members associated with the PLC type.
C#
public IPlcMemberInfo[] Members { get; }
Property Value
An array of IPlcMemberInfo objects.
Gets the name of the PLC type represented.
C#
public PlcName Name { get; }
Property Value
The name of the PLC type.
Gets a 32-bit integer that represents the total number of bytes required to store a value of the type within the PLC memory.
C#
public int Size { get; }
Property Value
A 32-bit integer that represents the total number of bytes required to store a value of the type within the PLC memory.
Gets a 32-bit integer that represents the total number of bits required to store a value of the type within the PLC memory.
C#
public int SizeInBits { get; }
Property Value
A 32-bit integer that represents the total number of bits required to store a value of the type within the PLC memory.
Gets the PlcTypeCode of the PLC type represented.
C#
public PlcTypeCode TypeCode { get; }
Property Value
One of members defined by the PlcTypeCode enumeration. Which defines the concrete type representation in a PLC device.
Creates a new IPlcEntity object which represents a concrete accessible entity of this PlcType.
C#
public virtual IPlcEntity CreateEntity()
Returns
An instance implementing the IPlcEntity interface its Type property does refer to this PlcType.
Exceptions
This pure PlcType instance can't create an entity, because it is an abstract type representation.
Retrieves the PlcType object encompassed or referred to by the current array type.
C#
public PlcType GetElementType(int index)
Parameters
index
Int32
The zero based index of the element type to requested.
Returns
The PlcType of the object encompassed or referred to by the current array or a null reference (Nothing in Visual Basic) if the current PlcType is not an array type.
Exceptions
The index
is outside the bounds defined by the MinLength and Length.
Retrieves the according PlcRawType for the typeCode
specified.
C#
public static PlcRawType GetRawType(PlcTypeCode typeCode)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode for that the PlcRawType is to be determined.
Returns
The according PlcRawType for typeCode
.
Retrieves the according PlcRawType for the type
specified.
C#
public static PlcRawType GetRawType(Type type)
Parameters
type
Type
The Type for that the PlcRawType is to be determined.
Returns
The according PlcRawType for type
.
Exceptions
The type
is a null reference (Nothing in Visual Basic).
Retrieves the according size for the rawType
specified.
C#
public static int GetSize(PlcRawType rawType)
Parameters
rawType
PlcRawType
The PlcRawType for that the size is to be determined.
Returns
The according size (in bytes) for rawType
.
Retrieves the according size (optionally in bytes or bits) for the rawType
specified.
C#
public static int GetSize(PlcRawType rawType, bool inBytes)
Parameters
rawType
PlcRawType
The PlcRawType for that the size is to be determined.
inBytes
Boolean
The value true, to retrieve the size of rawType
in bytes; otherwise the value false to retrieve the size in bits.
Returns
The according size either in bytes or in bits for rawType
.
Retrieves the according size for the typeCode
specified.
C#
public static int GetSize(PlcTypeCode typeCode)
Parameters
typeCode
PlcTypeCode
The PlcRawType for that the size is to be determined.
Returns
The according size (in bytes) for typeCode
.
Retrieves the according size (optionally in bytes or bits) for the typeCode
specified.
C#
public static int GetSize(PlcTypeCode typeCode, bool inBytes)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode for that the size is to be determined.
inBytes
Boolean
The value true, to retrieve the size of typeCode
in bytes; otherwise the value false to retrieve the size in bits.
Returns
The according size either in bytes or in bits for typeCode
.
Retrieves the according size (optionally in bytes or bits) for the type
specified.
C#
public static int GetSize(Type type, bool inBytes)
Parameters
type
Type
The Type for that the size is to be determined.
inBytes
Boolean
The value true, to retrieve the size of type
in bytes; otherwise the value false to retrieve the size in bits.
Returns
The according size either in bytes or in bits for type
.
Exceptions
The type
is a null reference (Nothing in Visual Basic).
Retrieves the PlcRawType members supported by the PlcTypeCode specified by typeCode
.
C#
public static PlcRawType[] GetSupportedRawTypes(PlcTypeCode typeCode)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode its supported PlcRawType members are to be determined.
Returns
An array of PlcRawType members supported by the typeCode
specified.
Remarks
Supported raw types means that these PlcRawType members can be used to address the PLC memory of such a PlcTypeCode by using one of the supported PlcRawType members.
Retrieves the PlcRawType members supported by the PlcTypeCode of the Type specified by type
.
C#
public static PlcRawType[] GetSupportedRawTypes(Type type)
Parameters
type
Type
The Type its PlcTypeCode is to be used to determine the supported PlcRawType members.
Returns
An array of PlcRawType members supported by the PlcTypeCode of the type
specified.
Exceptions
The type
is a null reference (Nothing in Visual Basic).
Remarks
Supported raw types means that these PlcRawType members cna be used to address the PLC memory of such a PlcTypeCode (identified by type
) by using one of the supported PlcRawType members.
Retrieves the according framework Type for the typeCode
specified.
C#
public static Type GetType(PlcTypeCode typeCode)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode for that the framework Type is to be determined.
Returns
The according framework Type for typeCode
.
Exceptions
The typeCode
is not supported.
Retrieves the according PlcTypeCode for the framework Type specified.
C#
public static PlcTypeCode GetTypeCode(Type type)
Parameters
type
Type
The framework Type for that the PlcTypeCode is to be determined.
Returns
The according PlcTypeCode for type
.
Exceptions
The type
is not supported.
The type
is a null reference (Nothing in Visual Basic).
Determines whether the specified rawType
can be used to address the PLC memory to access data of the PlcTypeCode specified by typeCode
.
C#
public static bool IsSupported(PlcTypeCode typeCode, PlcRawType rawType)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode its supported raw types are inspected to determine the accessibility of the PLC memory for such PLC data using the PlcRawType specified by rawType
.
rawType
PlcRawType
The PlcRawType its compatibility to address PLC data of the PlcTypeCode defined by typeCode
is to be inspected.
Returns
The value true if the PLC data of the typeCode
can be accessed using the PlcRawType specified by rawType
; otherwise the value false.
Determines whether the PlcTypeCode specified by typeCode
can be also used to access the PLC memory by an array of that PlcTypeCode.
C#
public static bool IsSupportedArrayType(PlcTypeCode typeCode)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode to inspect.
Returns
The value true if the PLC memory can be accessed by an array of the PlcTypeCode specified by typeCode
; otherwise the value false.
Retrieves the absolute PlcType using the PlcIdentity specified by identity
.
C#
public PlcType MakeAbsoluteType(PlcIdentity identity)
Parameters
identity
PlcIdentity
The PlcIdentity to use when the current PlcType is a relative type and the absolute type of the PlcType is created.
Returns
The reference to the current PlcType if IsAbsolute is equals true; otherwise another (but absolute) PlcType with the same type metadata including the identity
specified.
Exceptions
The identity
specified does not provide the necessary information required to address the type of data.
The identity
is a null reference (Nothing in Visual Basic).
Returns a PlcType object representing a one-dimensional array of the current type, with a length of zero.
C#
public PlcType MakeArrayType()
Returns
A PlcType object representing a one-dimensional array of the current type, with a length of zero.
Exceptions
The current PlcType is either already an array type (see IsArray) which would result into an unsupported jagged array type or the current PlcType is a PLC type which does not support array types (see IsSupportedArrayType(PlcTypeCode)).
Returns a PlcType object representing an array of the current type, with the specified length
.
C#
public PlcType MakeArrayType(int length)
Parameters
length
Int32
The length for the array.
Returns
An object representing an array of the current type, with the specified length
.
Exceptions
The length
is out of the bounds defined by MinLength and MaxLength.
The current PlcType is either already an array type (see IsArray) which would result into an unsupported jagged array type or the current PlcType is a PLC type which does not support array types (see IsSupportedArrayType(PlcTypeCode)).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty.
Remarks
Using this method it is possible to create from all PlcTypeCode member the according PlcType for value and object types. In general it is not possible to define PlcType which represent an array type using this method.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcIdentity identity)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or the identity
can not be used together with the typeCode
specified or identity
does not provide the necessary information required to address the type of data.
The identity
is a null reference (Nothing in Visual Basic).
Remarks
Using this method it is possible to create from all PlcTypeCode member the according PlcType for value and object types. In general it is not possible to define PlcType which represent an array type using this method.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcIdentity identity, int length)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The identity
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Remarks
This method does always construct array types using the PlcType. Therefore it is not possible to use the following PlcTypeCode members as the value for typeCode
: * Date.
It is also possible to construct a PlcType with the String through this method, there length
does specify the maximum number of characters in the string.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcIdentity identity, PlcName name)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or the identity
can not be used together with the typeCode
specified or identity
does not provide the necessary information required to address the type of data.
The identity
or name
is a null reference (Nothing in Visual Basic).
Remarks
Using this method it is possible to create from all PlcTypeCode member the according PlcType for value and object types. In general it is not possible to define PlcType which represent an array type using this method.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcIdentity identity, PlcName name, int length)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The identity
or name
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Remarks
This method does always construct array types using the PlcType. Therefore it is not possible to use the following PlcTypeCode members as the value for typeCode
: * Date.
It is also possible to construct a PlcType with the String through this method, there length
does specify the maximum number of characters in the string.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcIdentity identity, PlcName name, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or the identity
can not be used together with the typeCode
specified or identity
does not provide the necessary information required to address the type of data.
The identity
or name
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the typeCode
is equals Object.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcIdentity identity, PlcName name, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or the identity
can not be used together with the typeCode
specified or identity
does not provide the necessary information required to address the type of data.
The identity
, name
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the typeCode
is equals Object.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcIdentity identity, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or the identity
can not be used together with the typeCode
specified or identity
does not provide the necessary information required to address the type of data.
The identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the typeCode
is equals Object.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcIdentity identity, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or the identity
can not be used together with the typeCode
specified or identity
does not provide the necessary information required to address the type of data.
The identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the typeCode
is equals Object.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty.
The layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the typeCode
is equals Object.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty.
The layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the typeCode
is equals Object.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type.
The frameworkType
is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, int length)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type.
The frameworkType
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, int length, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type.
The frameworkType
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, int length, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type.
The frameworkType
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
or identity
is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, int length)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
or identity
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, int length, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, int length, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, PlcName name)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
or name
is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, PlcName name, int length)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
or name
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, PlcName name, int length, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, PlcName name, int length, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
, name
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, PlcName name, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
, name
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, PlcName name, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
, layout
or name
or members
or one of its items is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcIdentity identity, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type or typeCode
/ frameworkType
can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The frameworkType
, identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type.
The frameworkType
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(PlcTypeCode typeCode, Type frameworkType, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
typeCode
PlcTypeCode
The PlcTypeCode of the PLC type represented by the PlcType.
frameworkType
Type
The framework Type represented by the PlcType.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The typeCode
is Empty or frameworkType
is a not supported framework type or a jagged or multi-dimensional array type.
The frameworkType
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type)
Parameters
type
Type
The framework Type represented by the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type.
The type
is a null reference (Nothing in Visual Basic).
Remarks
If type
is a value type then PlcType will be also a value type. If type
is an array type then PlcType will be a array type with the length equals zero. The following PlcType can not constructed using this method: * Date.
In general specifying type
as a DateTime will result into a PlcType with the DateTime and specifying type
as a TimeSpan will result into a PlcType with the TimeOfDay.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcIdentity identity)
Parameters
type
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The type
or identity
is a null reference (Nothing in Visual Basic).
Remarks
If type
is a value type then PlcType will be also a value type. If type
is an array type then PlcType will be a array type with the length equals zero. The following PlcType can not constructed using this method: * Date.
In general specifying type
as a DateTime will result into a PlcType with the DateTime and specifying type
as a TimeSpan will result into a PlcType with the TimeOfDay.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcIdentity identity, int length)
Parameters
type
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The type
or identity
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Remarks
This method does always construct array types using the PlcType. Therefore it is not possible to use the following framework types as the value for type
: * DateTime.
It is also possible to construct a PlcType with the String through this method, there length
does specify the maximum number of characters in the string.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcIdentity identity, PlcName name)
Parameters
type
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The type
, identity
or name
is a null reference (Nothing in Visual Basic).
Remarks
If type
is a value type then PlcType will be also a value type. If type
is an array type then PlcType will be a array type with the length equals zero. The following PlcType can not constructed using this method: * Date.
In general specifying type
as a DateTime will result into a PlcType with the DateTime and specifying type
as a TimeSpan will result into a PlcType with the TimeOfDay.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcIdentity identity, PlcName name, int length)
Parameters
type
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The type
, identity
or name
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Remarks
This method does always construct array types using the PlcType. Therefore it is not possible to use the following framework types as the value for type
: * DateTime.
It is also possible to construct a PlcType with the String through this method, there length
does specify the maximum number of characters in the string.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcIdentity identity, PlcName name, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
type
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The type
, identity
, name
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the type
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcIdentity identity, PlcName name, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
type
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The type
, identity
, name
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the type
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcIdentity identity, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
type
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The type
, identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the type
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcIdentity identity, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
type
Type
The framework Type represented by the PlcType.
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type or it can not be used together with the identity
specified or identity
does not provide the necessary information required to address the type of data.
The type
, identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the type
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
type
Type
The framework Type represented by the PlcType.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type.
The type
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the type
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of(Type type, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
type
Type
The framework Type represented by the PlcType.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The type
is a not supported framework type or a jagged multi-dimensional array type.
The type
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the type
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>()
Returns
The PlcType which matches with the characteristics supplied.
Remarks
If T
is a value type then PlcType will be also a value type. If T
is an array type then PlcType will be a array type with the length equals zero. The following PlcType can not constructed using this method: * Date.
In general specifying T
as a DateTime will result into a PlcType with the DateTime and specifying T
as a TimeSpan will result into a PlcType with the TimeOfDay.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcIdentity identity)
Parameters
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The identity
can not be used together with T
specified or identity
does not provide the necessary information required to address the type of data.
The identity
is a null reference (Nothing in Visual Basic).
Remarks
If T
is a value type then PlcType will be also a value type. If T
is an array type then PlcType will be a array type with the length equals zero. The following PlcType can not constructed using this method: * Date.
In general specifying T
as a DateTime will result into a PlcType with the DateTime and specifying T
as a TimeSpan will result into a PlcType with the TimeOfDay.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcIdentity identity, int length)
Parameters
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The identity
can not be used together with T
specified or identity
does not provide the necessary information required to address the type of data.
The identity
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Remarks
This method does always construct array types using the PlcType. Therefore it is not possible to use the following framework types as the value for T
: * DateTime.
It is also possible to construct a PlcType with the String through this method, there length
does specify the maximum number of characters in the string.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcIdentity identity, PlcName name)
Parameters
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The identity
can not be used together with T
specified or identity
does not provide the necessary information required to address the type of data.
The identity
or name
is a null reference (Nothing in Visual Basic).
Remarks
If T
is a value type then PlcType will be also a value type. If T
is an array type then PlcType will be a array type with the length equals zero. The following PlcType can not constructed using this method: * Date.
In general specifying T
as a DateTime will result into a PlcType with the DateTime and specifying T
as a TimeSpan will result into a PlcType with the TimeOfDay.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcIdentity identity, PlcName name, int length)
Parameters
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
length
Int32
The length of the PlcType which either specifies the total number of elements in an array type or the total number of characters in a string type.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The identity
can not be used together with T
specified or identity
does not provide the necessary information required to address the type of data.
The identity
or name
is a null reference (Nothing in Visual Basic).
The length
is out of the bounds defined by MinLength and MaxLength or MinLength and MaxLength.
Remarks
This method does always construct array types using the PlcType. Therefore it is not possible to use the following framework types as the value for T
: * DateTime.
It is also possible to construct a PlcType with the String through this method, there length
does specify the maximum number of characters in the string.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcIdentity identity, PlcName name, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The identity
can not be used together with T
specified or identity
does not provide the necessary information required to address the type of data.
The identity
, name
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the T
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcIdentity identity, PlcName name, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
name
PlcName
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The identity
can not be used together with T
specified or identity
does not provide the necessary information required to address the type of data.
The identity
, name
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the T
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcIdentity identity, PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The identity
can not be used together with T
specified or identity
does not provide the necessary information required to address the type of data.
The identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the T
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcIdentity identity, PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
identity
PlcIdentity
The PlcIdentity to which the PlcType does refer.
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The identity
can not be used together with T
specified or identity
does not provide the necessary information required to address the type of data.
The identity
, layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the T
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcTypeLayout layout, IEnumerable<IPlcMemberInfo> members)
Parameters
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IEnumerable<IPlcMemberInfo>
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the T
is either of the type of PlcObject or a derivate of the class.
Retrieves the according PlcType which matches the supplied type metadata.
C#
public static PlcType Of<T>(PlcTypeLayout layout, params IPlcMemberInfo[] members)
Parameters
layout
PlcTypeLayout
An instance of the PlcTypeLayout class which provides the characteristics to use to absolutely align the members
.
members
IPlcMemberInfo[]
The IPlcMemberInfo objects to associate with the PlcType.
Returns
The PlcType which matches with the characteristics supplied.
Exceptions
The layout
or members
or one of its items is a null reference (Nothing in Visual Basic).
Remarks
This method does only construct PlcType objects there the T
is either of the type of PlcObject or a derivate of the class.
Relocates the PlcType using the specified offset.
C#
public PlcType Relocate(int operandNumber)
Parameters
operandNumber
Int32
The operand number offset used to adjust the Address.
Returns
A new instance of the PlcType configured with the same metadata as this instance but relocated using the specified offset.
Exceptions
The offset specified by operandNumber
result into a new value that would be out of the bounds defined by MinOperandNumber or MaxOperandNumber.
It is not possible to relocate relative types (see IsAbsolute property).
Relocates the PlcType using the specified offset.
C#
public PlcType Relocate(int operandNumber, int byteNumber)
Parameters
operandNumber
Int32
The operand number offset used to adjust the Address.
byteNumber
Int32
The byte number offset used to adjust the Address.
Returns
A new instance of the PlcType configured with the same metadata as this instance but relocated using the specified offset.
Exceptions
One of the offsets specified by operandNumber
or byteNumber
result into a new value that would be out of the bounds defined by MinOperandNumber, MaxOperandNumber, MinByteNumber and MaxByteNumber.
It is not possible to relocate relative types (see IsAbsolute property).
Relocates the PlcType using the specified offset.
C#
public PlcType Relocate(int operandNumber, int byteNumber, int bitNumber)
Parameters
operandNumber
Int32
The operand number offset used to adjust the Address.
byteNumber
Int32
The byte number offset used to adjust the Address.
bitNumber
Int32
The bit number offset used to adjust the Address.
Returns
A new instance of the PlcType configured with the same metadata as this instance but relocated using the specified offset.
Exceptions
One of the offsets specified by operandNumber
, byteNumber
or bitNumber
result into a new value that would be out of the bounds defined by MinOperandNumber, MaxOperandNumber, MinByteNumber, MaxByteNumber, MinBitNumber or MaxBitNumber.
It is not possible to relocate relative types (see IsAbsolute property).
Relocates the PlcType using the specified address
.
C#
public PlcType Relocate(PlcAddress address)
Parameters
address
PlcAddress
The PlcAddress to that the type is to be relocated.
Returns
A new instance of the PlcType configured with the same metadata as this instance but relocated using the specified address
.
Exceptions
The address
is a null reference (Nothing in Visual Basic).
The address
does not refer to the same PlcRawType as this PlcType.
It is not possible to relocate absolute object types without relative type information.
Remarks
The RawType of the address
specified needs to be the same as defined by the Address of the PLC type.