RYTEC
/
libiec61850
mirror of https://github.com/mz-automation/libiec61850.git
6
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

- .NET API: Added properties to MmsVariableSpecification class (LIB61850-460)

Browse Source
pull/535/head
Michael Zillgith 11 months ago
parent 830059fca2
commit ae02944918
1 changed files with 179 additions and 107 deletions
Show Stats Download Patch File Download Diff File

286
dotnet/IEC61850forCSharp/MmsVariableSpecification.cs
Unescape Escape View File

@ -1,7 +1,7 @@
/* /*
* MmsVariableSpecification.cs * MmsVariableSpecification.cs
* *
* Copyright 2014 Michael Zillgith * Copyright 2014-2024 Michael Zillgith
* *
* This file is part of libIEC61850. * This file is part of libIEC61850.
* *
@ -30,58 +30,58 @@ using System.Text;
namespace IEC61850 namespace IEC61850
{ {
namespace Common namespace Common
{ {
/// <summary> /// <summary>
/// MMS variable specification. This class is used to represent an MMS variable type definition. /// MMS variable specification. This class is used to represent an MMS variable type definition.
/// </summary> /// </summary>
public class MmsVariableSpecification : IEnumerable public class MmsVariableSpecification : IEnumerable
{ {
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern void MmsVariableSpecification_destroy(IntPtr self); static extern void MmsVariableSpecification_destroy(IntPtr self);
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr MmsVariableSpecification_getNamedVariableRecursive(IntPtr variable, string nameId); static extern IntPtr MmsVariableSpecification_getNamedVariableRecursive(IntPtr variable, string nameId);
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern int MmsVariableSpecification_getType(IntPtr self); static extern int MmsVariableSpecification_getType(IntPtr self);
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr MmsVariableSpecification_getName(IntPtr self); static extern IntPtr MmsVariableSpecification_getName(IntPtr self);
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern int MmsVariableSpecification_getSize(IntPtr self); static extern int MmsVariableSpecification_getSize(IntPtr self);
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr MmsVariableSpecification_getChildSpecificationByIndex(IntPtr self, int index); static extern IntPtr MmsVariableSpecification_getChildSpecificationByIndex(IntPtr self, int index);
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern IntPtr MmsVariableSpecification_getArrayElementSpecification(IntPtr self); static extern IntPtr MmsVariableSpecification_getArrayElementSpecification(IntPtr self);
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern int MmsVariableSpecification_getExponentWidth(IntPtr self); static extern int MmsVariableSpecification_getExponentWidth(IntPtr self);
[DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)] [DllImport("iec61850", CallingConvention = CallingConvention.Cdecl)]
static extern bool MmsVariableSpecification_isValueOfType(IntPtr self, IntPtr value); static extern bool MmsVariableSpecification_isValueOfType(IntPtr self, IntPtr value);
internal IntPtr self; internal IntPtr self;
private bool responsableForDeletion; private bool responsableForDeletion;
/* only to prevent garbage collector to destroy parent element */ /* only to prevent garbage collector to destroy parent element */
internal MmsVariableSpecification parent = null; internal MmsVariableSpecification parent = null;
internal MmsVariableSpecification (IntPtr self, MmsVariableSpecification parent) internal MmsVariableSpecification(IntPtr self, MmsVariableSpecification parent)
{ {
this.self = self; this.self = self;
this.responsableForDeletion = false; this.responsableForDeletion = false;
this.parent = parent; this.parent = parent;
} }
internal MmsVariableSpecification (IntPtr self, bool responsableForDeletion) internal MmsVariableSpecification(IntPtr self, bool responsableForDeletion)
{ {
this.self = self; this.self = self;
this.responsableForDeletion = responsableForDeletion; this.responsableForDeletion = responsableForDeletion;
} }
/// <summary> /// <summary>
/// Get a child variable specification by its name /// Get a child variable specification by its name
@ -104,11 +104,11 @@ namespace IEC61850
return null; return null;
} }
~MmsVariableSpecification () ~MmsVariableSpecification()
{ {
if (responsableForDeletion) if (responsableForDeletion)
MmsVariableSpecification_destroy(self); MmsVariableSpecification_destroy(self);
} }
/// <summary> /// <summary>
/// Gets the MmsValue type of the variable /// Gets the MmsValue type of the variable
@ -116,10 +116,18 @@ namespace IEC61850
/// <returns> /// <returns>
/// The MmsType of the variable /// The MmsType of the variable
/// </returns> /// </returns>
public new MmsType GetType () public new MmsType GetType()
{ {
return (MmsType) MmsVariableSpecification_getType(self); return (MmsType)MmsVariableSpecification_getType(self);
} }
/// <summary>
/// The MmsValue type of the variable
/// </summary>
public MmsType MmsType
{
get { return (MmsType)MmsVariableSpecification_getType(self); }
}
/// <summary> /// <summary>
/// Gets the type of the array elements. /// Gets the type of the array elements.
@ -128,15 +136,33 @@ namespace IEC61850
/// The array element type. /// The array element type.
/// </returns> /// </returns>
/// <exception cref="MmsValueException">This exception is thrown if the value is not of type MMS_ARRAY</exception> /// <exception cref="MmsValueException">This exception is thrown if the value is not of type MMS_ARRAY</exception>
public MmsVariableSpecification getArrayElementType () public MmsVariableSpecification getArrayElementType()
{ {
if (GetType() == MmsType.MMS_ARRAY) { if (GetType() == MmsType.MMS_ARRAY)
IntPtr varSpecPtr = MmsVariableSpecification.MmsVariableSpecification_getArrayElementSpecification(self); {
return new MmsVariableSpecification(varSpecPtr, this); IntPtr varSpecPtr = MmsVariableSpecification.MmsVariableSpecification_getArrayElementSpecification(self);
} return new MmsVariableSpecification(varSpecPtr, this);
else }
throw new MmsValueException ("specification is of wrong type"); else
} throw new MmsValueException("specification is of wrong type");
}
/// <summary>
/// The type of array elements (when the variable is of type MMS_ARRAY)
/// </summary>
public MmsVariableSpecification ArrayElementType
{
get
{
if (GetType() == MmsType.MMS_ARRAY)
{
IntPtr varSpecPtr = MmsVariableSpecification.MmsVariableSpecification_getArrayElementSpecification(self);
return new MmsVariableSpecification(varSpecPtr, this);
}
else
return null;
}
}
/// <summary> /// <summary>
/// Gets the element specification of a structure element /// Gets the element specification of a structure element
@ -147,41 +173,86 @@ namespace IEC61850
/// <param name='index'> /// <param name='index'>
/// Index. /// Index.
/// </param> /// </param>
public MmsVariableSpecification GetElement (int index) public MmsVariableSpecification GetElement(int index)
{ {
if (GetType () == MmsType.MMS_STRUCTURE) { if (GetType() == MmsType.MMS_STRUCTURE)
{
if ((index >= 0) && (index < Size ())) {
IntPtr varSpecPtr = MmsVariableSpecification_getChildSpecificationByIndex(self, index); if ((index >= 0) && (index < Size()))
return new MmsVariableSpecification(varSpecPtr, this); {
} IntPtr varSpecPtr = MmsVariableSpecification_getChildSpecificationByIndex(self, index);
else return new MmsVariableSpecification(varSpecPtr, this);
throw new MmsValueException ("Index out of bounds"); }
} else
else throw new MmsValueException("Index out of bounds");
throw new MmsValueException ("specification is of wrong type"); }
} else
throw new MmsValueException("specification is of wrong type");
}
/// <summary> /// <summary>
/// Gets the name of the variable /// The element types for complex variables (MMS_STRUCTURE)
/// </summary>
public MmsVariableSpecification[] Elements
{
get
{
if (GetType() != MmsType.MMS_STRUCTURE)
return null;
List<MmsVariableSpecification> elements = new List<MmsVariableSpecification>();
for (int i = 0; i < Size(); i++)
{
elements.Add(GetElement(i));
}
return elements.ToArray();
}
}
/// <summary>
/// Gets the name of the variable (relative to the parent)
/// </summary> /// </summary>
/// <returns> /// <returns>
/// The name. /// The name.
/// </returns> /// </returns>
public string GetName () public string GetName()
{ {
IntPtr namePtr = MmsVariableSpecification_getName(self); IntPtr namePtr = MmsVariableSpecification_getName(self);
return Marshal.PtrToStringAnsi(namePtr);
}
return Marshal.PtrToStringAnsi (namePtr); /// <summary>
} /// The name of the variable (relative to the parent)
/// </summary>
public string Name
{
get
{
return GetName();
}
}
/// <summary> /// <summary>
/// Get the "size" of the variable (array size, number of structure elements ...) /// Get the "size" of the variable (array size, number of structure elements ...)
/// </summary> /// </summary>
public int Size () public int Size()
{ {
return MmsVariableSpecification_getSize(self); return MmsVariableSpecification_getSize(self);
} }
/// <summary>
/// The "size" of the variable (array size, number of structure elements ...)
/// </summary>
public int size
{
get
{
return MmsVariableSpecification_getSize(self);
}
}
/// <summary> /// <summary>
/// Determines whether the given value object matches this type /// Determines whether the given value object matches this type
@ -193,45 +264,46 @@ namespace IEC61850
return MmsVariableSpecification_isValueOfType(self, value.valueReference); return MmsVariableSpecification_isValueOfType(self, value.valueReference);
} }
IEnumerator IEnumerable.GetEnumerator () IEnumerator IEnumerable.GetEnumerator()
{ {
return new MmsVariableSpecificationEnumerator (this); return new MmsVariableSpecificationEnumerator(this);
} }
private class MmsVariableSpecificationEnumerator : IEnumerator private class MmsVariableSpecificationEnumerator : IEnumerator
{ {
private MmsVariableSpecification value; private MmsVariableSpecification value;
private int index = -1; private int index = -1;
public MmsVariableSpecificationEnumerator (MmsVariableSpecification value) public MmsVariableSpecificationEnumerator(MmsVariableSpecification value)
{ {
this.value = value; this.value = value;
} }
#region IEnumerator Members #region IEnumerator Members
public void Reset () public void Reset()
{ {
index = -1; index = -1;
} }
public object Current { public object Current
{
get { return value.GetElement (index);} get { return value.GetElement(index); }
} }
public bool MoveNext () public bool MoveNext()
{ {
index++; index++;
if (index >= value.Size ()) if (index >= value.Size())
return false; return false;
else else
return true; return true;
} }
#endregion #endregion
} }
} }
} }
} }

Write Preview
Loading…
Cancel
Save