.NET Based OPC UA Client/Server SDK  2.6.0.418
UnifiedAutomation.UaClient.SelectClauseCollection Class Reference

A collection of select clauses. More...

Inherits IList< SimpleAttributeOperand >.

Public Member Functions

string GetDisplayText (int index)
 Gets the display text. More...
 
int Find (QualifiedName browseName)
 Finds the specified browse name. More...
 
int Find (ExpandedNodeId typeId, QualifiedName browseName)
 Finds the specified type id. More...
 
int Find (QualifiedName[] browsePath)
 Finds the specified browse path. More...
 
int Find (ExpandedNodeId typeId, QualifiedName[] browsePath)
 Finds the specified browse path. More...
 
int Find (ExpandedNodeId typeId, QualifiedName[] browsePath, NodeClass nodeClass)
 Finds the match selecting clause. More...
 
void Add (TypeFieldDescription field)
 Adds the specified field. More...
 
void Add (TypeFieldDescription field, NumericRange indexRange)
 Adds the specified field. More...
 
void Add (ExpandedNodeId typeId, QualifiedName[] browsePath)
 Adds the specified type id. More...
 
void Add (ExpandedNodeId typeId, QualifiedName[] browsePath, NumericRange indexRange)
 Adds the specified type id. More...
 
void Add (ExpandedNodeId typeId, QualifiedName[] browsePath, NodeClass nodeClass)
 Adds the specified type id. More...
 
void Add (QualifiedName browseName)
 Adds the specified browse name. More...
 
void Add (ExpandedNodeId typeId, QualifiedName browseName)
 Adds the specified type id. More...
 
void Add (ExpandedNodeId typeId, QualifiedName browseName, NumericRange indexRange)
 Adds the specified type id. More...
 
void Add (ExpandedNodeId typeId, QualifiedName browseName, NodeClass nodeClass)
 Adds the specified type id. More...
 
int IndexOf (SimpleAttributeOperand item)
 Determines the index of a specific item in the T:System.Collections.Generic.IList`1. More...
 
void Insert (int index, SimpleAttributeOperand item)
 Inserts an item to the T:System.Collections.Generic.IList`1 at the specified index. More...
 
void RemoveAt (int index)
 Removes the T:System.Collections.Generic.IList`1 item at the specified index. More...
 
void Add (SimpleAttributeOperand item)
 Adds an item to the T:System.Collections.Generic.ICollection`1. More...
 
void Clear ()
 Removes all items from the T:System.Collections.Generic.ICollection`1. More...
 
bool Contains (SimpleAttributeOperand item)
 Determines whether the T:System.Collections.Generic.ICollection`1 contains a specific value. More...
 
void CopyTo (SimpleAttributeOperand[] array, int arrayIndex)
 Copies the elements of the T:System.Collections.Generic.ICollection`1 to an T:System.Array, starting at a particular T:System.Array index. More...
 
bool Remove (SimpleAttributeOperand item)
 Removes the first occurrence of a specific object from the T:System.Collections.Generic.ICollection`1. More...
 
IEnumerator
< SimpleAttributeOperand
GetEnumerator ()
 Returns an enumerator that iterates through the collection. More...
 

Properties

SimpleAttributeOperand this[int index] [get, set]
 Gets or sets the element at the specified index. More...
 
int Count [get]
 Gets the number of elements contained in the T:System.Collections.Generic.ICollection`1. More...
 
bool IsReadOnly [get]
 Gets a value indicating whether the T:System.Collections.Generic.ICollection`1 is read-only. More...
 

Detailed Description

A collection of select clauses.

Member Function Documentation

void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( TypeFieldDescription  field)
inline

Adds the specified field.

Parameters
fieldThe field.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( TypeFieldDescription  field,
NumericRange  indexRange 
)
inline

Adds the specified field.

Parameters
fieldThe field.
indexRangeThe index range.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( ExpandedNodeId  typeId,
QualifiedName[]  browsePath 
)
inline

Adds the specified type id.

Parameters
typeIdThe type id.
browsePathThe browse path.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( ExpandedNodeId  typeId,
QualifiedName[]  browsePath,
NumericRange  indexRange 
)
inline

Adds the specified type id.

Parameters
typeIdThe type id.
browsePathThe browse path.
indexRangeThe index range.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( ExpandedNodeId  typeId,
QualifiedName[]  browsePath,
NodeClass  nodeClass 
)
inline

Adds the specified type id.

Parameters
typeIdThe type id.
browsePathThe browse path.
nodeClassThe node class.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( QualifiedName  browseName)
inline

Adds the specified browse name.

Parameters
browseNameName of the browse.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( ExpandedNodeId  typeId,
QualifiedName  browseName 
)
inline

Adds the specified type id.

Parameters
typeIdThe type id.
browseNameName of the browse.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( ExpandedNodeId  typeId,
QualifiedName  browseName,
NumericRange  indexRange 
)
inline

Adds the specified type id.

Parameters
typeIdThe type id.
browseNameName of the browse.
indexRangeThe index range.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( ExpandedNodeId  typeId,
QualifiedName  browseName,
NodeClass  nodeClass 
)
inline

Adds the specified type id.

Parameters
typeIdThe type id.
browseNameName of the browse.
nodeClassThe node class.
void UnifiedAutomation.UaClient.SelectClauseCollection.Add ( SimpleAttributeOperand  item)
inline

Adds an item to the T:System.Collections.Generic.ICollection`1.

Parameters
itemThe object to add to the T:System.Collections.Generic.ICollection`1.
Exceptions
T:System.NotSupportedExceptionThe T:System.Collections.Generic.ICollection`1 is read-only.
void UnifiedAutomation.UaClient.SelectClauseCollection.Clear ( )
inline

Removes all items from the T:System.Collections.Generic.ICollection`1.

Exceptions
T:System.NotSupportedExceptionThe T:System.Collections.Generic.ICollection`1 is read-only.
bool UnifiedAutomation.UaClient.SelectClauseCollection.Contains ( SimpleAttributeOperand  item)
inline

Determines whether the T:System.Collections.Generic.ICollection`1 contains a specific value.

Parameters
itemThe object to locate in the T:System.Collections.Generic.ICollection`1.
Returns
true if item is found in the T:System.Collections.Generic.ICollection`1; otherwise, false.
void UnifiedAutomation.UaClient.SelectClauseCollection.CopyTo ( SimpleAttributeOperand[]  array,
int  arrayIndex 
)
inline

Copies the elements of the T:System.Collections.Generic.ICollection`1 to an T:System.Array, starting at a particular T:System.Array index.

Parameters
arrayThe one-dimensional T:System.Array that is the destination of the elements copied from T:System.Collections.Generic.ICollection`1. The T:System.Array must have zero-based indexing.
arrayIndexThe zero-based index in array at which copying begins.
Exceptions
T:System.ArgumentNullExceptionarray is null.
Exceptions
T:System.ArgumentOutOfRangeExceptionarrayIndex is less than 0.
Exceptions
T:System.ArgumentExceptionarray is multidimensional. -or- arrayIndex is equal to or greater than the length of array . -or- The number of elements in the source T:System.Collections.Generic.ICollection`1 is greater than the available space from arrayIndex to the end of the destination array .
int UnifiedAutomation.UaClient.SelectClauseCollection.Find ( QualifiedName  browseName)
inline

Finds the specified browse name.

Parameters
browseNameName of the browse.
Returns
int UnifiedAutomation.UaClient.SelectClauseCollection.Find ( ExpandedNodeId  typeId,
QualifiedName  browseName 
)
inline

Finds the specified type id.

Parameters
typeIdThe type id.
browseNameName of the browse.
Returns
int UnifiedAutomation.UaClient.SelectClauseCollection.Find ( QualifiedName[]  browsePath)
inline

Finds the specified browse path.

Parameters
browsePathThe browse path.
Returns
int UnifiedAutomation.UaClient.SelectClauseCollection.Find ( ExpandedNodeId  typeId,
QualifiedName[]  browsePath 
)
inline

Finds the specified browse path.

Parameters
typeIdThe type id.
browsePathThe browse path.
Returns
int UnifiedAutomation.UaClient.SelectClauseCollection.Find ( ExpandedNodeId  typeId,
QualifiedName[]  browsePath,
NodeClass  nodeClass 
)
inline

Finds the match selecting clause.

Parameters
typeIdThe type id.
browsePathThe browse path.
nodeClassThe node class.
Returns
string UnifiedAutomation.UaClient.SelectClauseCollection.GetDisplayText ( int  index)
inline

Gets the display text.

Parameters
indexThe index.
Returns
IEnumerator<SimpleAttributeOperand> UnifiedAutomation.UaClient.SelectClauseCollection.GetEnumerator ( )
inline

Returns an enumerator that iterates through the collection.

Returns
A T:System.Collections.Generic.IEnumerator`1 that can be used to iterate through the collection.
int UnifiedAutomation.UaClient.SelectClauseCollection.IndexOf ( SimpleAttributeOperand  item)
inline

Determines the index of a specific item in the T:System.Collections.Generic.IList`1.

Parameters
itemThe object to locate in the T:System.Collections.Generic.IList`1.
Returns
The index of item if found in the list; otherwise, -1.
void UnifiedAutomation.UaClient.SelectClauseCollection.Insert ( int  index,
SimpleAttributeOperand  item 
)
inline

Inserts an item to the T:System.Collections.Generic.IList`1 at the specified index.

Parameters
indexThe zero-based index at which item should be inserted.
itemThe object to insert into the T:System.Collections.Generic.IList`1.
Exceptions
T:System.ArgumentOutOfRangeExceptionindex is not a valid index in the T:System.Collections.Generic.IList`1.
Exceptions
T:System.NotSupportedExceptionThe T:System.Collections.Generic.IList`1 is read-only.
bool UnifiedAutomation.UaClient.SelectClauseCollection.Remove ( SimpleAttributeOperand  item)
inline

Removes the first occurrence of a specific object from the T:System.Collections.Generic.ICollection`1.

Parameters
itemThe object to remove from the T:System.Collections.Generic.ICollection`1.
Returns
true if item was successfully removed from the T:System.Collections.Generic.ICollection`1; otherwise, false. This method also returns false if item is not found in the original T:System.Collections.Generic.ICollection`1.
Exceptions
T:System.NotSupportedExceptionThe T:System.Collections.Generic.ICollection`1 is read-only.
void UnifiedAutomation.UaClient.SelectClauseCollection.RemoveAt ( int  index)
inline

Removes the T:System.Collections.Generic.IList`1 item at the specified index.

Parameters
indexThe zero-based index of the item to remove.
Exceptions
T:System.ArgumentOutOfRangeExceptionindex is not a valid index in the T:System.Collections.Generic.IList`1.
Exceptions
T:System.NotSupportedExceptionThe T:System.Collections.Generic.IList`1 is read-only.

Property Documentation

int UnifiedAutomation.UaClient.SelectClauseCollection.Count
get

Gets the number of elements contained in the T:System.Collections.Generic.ICollection`1.

Returns
The number of elements contained in the T:System.Collections.Generic.ICollection`1.
bool UnifiedAutomation.UaClient.SelectClauseCollection.IsReadOnly
get

Gets a value indicating whether the T:System.Collections.Generic.ICollection`1 is read-only.

Returns
true if the T:System.Collections.Generic.ICollection`1 is read-only; otherwise, false.
SimpleAttributeOperand UnifiedAutomation.UaClient.SelectClauseCollection.this[int index]
getset

Gets or sets the element at the specified index.

Returns
The element at the specified index.
Exceptions
T:System.ArgumentOutOfRangeExceptionindex is not a valid index in the T:System.Collections.Generic.IList`1.
Exceptions
T:System.NotSupportedExceptionThe property is set and the T:System.Collections.Generic.IList`1 is read-only.

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