Constructor ElementConfiguration

Namespace

Skyline.DataMiner.Core.DataMinerSystem.Common

Assembly

Skyline.DataMiner.Core.DataMinerSystem.Common.dll

ElementConfiguration(IDms, string, IDmsProtocol)

Initializes a new instance of the ElementConfiguration class for protocols that do not require connection-specific configuration.

public ElementConfiguration(IDms dms, string elementName, IDmsProtocol protocol)

Parameters

dms IDms

The IDms interface.

elementName string

The element name.

protocol IDmsProtocol

The protocol.

Remarks

Forbidden characters: '', '/', ':', '*', '?', '"', '<', '>', '|', '°', ';'. Use the overload with IEnumerable<IElementConnection> for protocols that require connection-specific configuration.

Exceptions

ArgumentNullException

dms is null.

ArgumentNullException

elementName is null.

ArgumentNullException

protocol is null.

ArgumentException

elementName is empty or white space.

ArgumentException

elementName exceeds 200 characters.

ArgumentException

elementName contains a forbidden character.

ArgumentException

elementName contains more than one '%' character.

IncorrectDataException

The protocol declares a connection type that requires explicit connection settings.

ElementConfiguration(IDms, string, IDmsProtocol, IEnumerable<IElementConnection>)

Initializes a new instance of the ElementConfiguration class.

public ElementConfiguration(IDms dms, string elementName, IDmsProtocol protocol, IEnumerable<IElementConnection> connectionInfo)

Parameters

dms IDms

The IDms interface.

elementName string

The element name.

protocol IDmsProtocol

The protocol.

connectionInfo IEnumerable<IElementConnection>

The Connections that will be used to create the element.

Remarks

Forbidden characters: '', '/', ':', '*', '?', '"', '<', '>', '|', '°', ';'.

Exceptions

ArgumentNullException

dms is null.

ArgumentNullException

elementName is null.

ArgumentNullException

protocol is null.

ArgumentNullException

connectionInfo is null.

ArgumentException

elementName is empty or white space.

ArgumentException

elementName exceeds 200 characters.

ArgumentException

elementName contains a forbidden character.

ArgumentException

elementName contains more than one '%' character.

ArgumentException

More connections are provided than the protocol declares.

IncorrectDataException

A connection does not match the type the protocol declares at that index.