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

 Manage book (0 page(s))
 Help

PlcName Members

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

Constructors

PlcName(SerializationInfo, StreamingContext)

Initializes a new instance of the PlcName class with serialized data.

C# 

protected PlcName(SerializationInfo info, StreamingContext context)


Parameters

info Serialization.SerializationInfo

The Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.

context Serialization.StreamingContext

The Serialization.StreamingContext that contains contextual information about the source or destination.


Exceptions

ArgumentNullException

The info parameter is null reference (Nothing in Visual Basic).

Serialization.SerializationException

The class name is null reference (Nothing in Visual Basic) or HResult is zero (0).

Properties

Value

Gets the value of the name.

C# 

public string Value { get; }


Property Value

String

A String value which identifies the name represented.

Methods

CompareTo(Object)

Compares the current PlcName with the other.

C# 

public override int CompareTo(object other)


Parameters

other Object

The PlcName to compare with this PlcName.


Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(Object)).

CompareTo(PlcName)

Compares the current PlcName with another PlcName.

C# 

public int CompareTo(PlcName other)


Parameters

other PlcName

The PlcName to compare with this PlcName.


Returns

Int32

A 32-bit signed integer that indicates the relative order of the objects being compared (CompareTo(0)).

Equals(Object)

Determines whether the specified other is equal to this PlcName.

C# 

public override bool Equals(object other)


Parameters

other Object

The PlcName to compare to the current PlcName.


Returns

Boolean

The value true if the specified PlcName is equal to the current PlcName; otherwise the value false.

Equals(PlcName)

Determines whether the specified other is equal to this PlcName.

C# 

public bool Equals(PlcName other)


Parameters

other PlcName

The PlcName to compare to the current PlcName.


Returns

Boolean

The value true if the specified PlcName is equal to the current PlcName; otherwise the value false.

GetHashCode()

Retrieves a hash code for this PlcName.

C# 

public override int GetHashCode()


Returns

Int32

An Int32 that contains the hash code for the PlcName.

GetObjectData(SerializationInfo, StreamingContext)

Sets the Serialization.SerializationInfo with information about the exception.

C# 

[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
public override void GetObjectData(SerializationInfo info, StreamingContext context)


Parameters

info Serialization.SerializationInfo

The Serialization.SerializationInfo that holds the serialized object data about the exception being thrown.

context Serialization.StreamingContext

The Serialization.StreamingContext that contains contextual information about the source or destination.



Exceptions

ArgumentNullException

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

Parse(String)

Converts a name string to a PlcName instance.

C# 

public static PlcName Parse(string value)


Parameters

value String

A string that contains the name.


Returns

PlcName

An instance of the PlcName class.



Exceptions

FormatException

The value is not a valid name.

ToString()

Converts the name to its string representation.

C# 

public override string ToString()


Returns

String

A string that contains the name.

TryParse(String, out PlcName)

Determines whether a string is a valid name.

C# 

public static bool TryParse(string value, out PlcName name)


Parameters

value String

The string to validate.

name PlcName

The PlcName version of the string.


Returns

Boolean

The value true, if value is a valid name; otherwise the value false.

Operators

Equality(PlcName, PlcName)

Returns a value indicating whether two instance of PlcName are equal.

C# 

public static bool operator ==(PlcName left, PlcName right)

GreaterThan(PlcName, PlcName)

Determines whether the first specified PlcName object is greater than the second specified PlcName object.

C# 

public static bool operator>(PlcName left, PlcName right)

GreaterThanOrEqual(PlcName, PlcName)

Determines whether the first specified PlcName object is greater than or equal to the second specified PlcName object.

C# 

public static bool operator >=(PlcName left, PlcName right)

Implicit(String to PlcName)

Converts a string formatted as name to an PlcName object.

C# 

public static implicit operator PlcName(string value)


Exceptions

FormatException

The value is not a valid PLC name.

Inequality(PlcName, PlcName)

Returns a value indicating whether two instances of PlcName are not equal.

C# 

public static bool operator !=(PlcName left, PlcName right)

LessThan(PlcName, PlcName)

Determines whether the first specified PlcName object is less than the second specified PlcName object.

C# 

public static bool operator <(PlcName left, PlcName right)


Exceptions

ArgumentNullException

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

LessThanOrEqual(PlcName, PlcName)

Determines whether the first specified PlcName object is less than or equal to the second PlcName object.

C# 

public static bool operator <=(PlcName left, PlcName right)


Exceptions

ArgumentNullException

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