IEC61850.Common.MmsVariableSpecification Class Reference

MMS variable specification. This class is used to represent an MMS variable type definition. More...

Inheritance diagram for IEC61850.Common.MmsVariableSpecification:

Collaboration diagram for IEC61850.Common.MmsVariableSpecification:

Public Member Functions
MmsVariableSpecification	GetChildByName (string name)
	Get a child variable specification by its name More...
new MmsType	GetType ()
	Gets the MmsValue type of the variable More...
MmsVariableSpecification	getArrayElementType ()
	Gets the type of the array elements. More...
MmsVariableSpecification	GetElement (int index)
	Gets the element specification of a structure element More...
string	GetName ()
	Gets the name of the variable More...
int	Size ()
	Get the "size" of the variable (array size, number of structure elements ...) More...
bool	IsValueOfType (MmsValue value)
	Determines whether the given value object matches this type More...

Detailed Description

MMS variable specification. This class is used to represent an MMS variable type definition.

Member Function Documentation

getArrayElementType()

MmsVariableSpecification IEC61850.Common.MmsVariableSpecification.getArrayElementType

(

)

Gets the type of the array elements.

Returns

The array element type.

Exceptions

MmsValueException

This exception is thrown if the value is not of type MMS_ARRAY

GetChildByName()

MmsVariableSpecification IEC61850.Common.MmsVariableSpecification.GetChildByName

(

string

name

)

Get a child variable specification by its name

Returns

the varibable specification of the child, or null if no such child is existing.

Parameters

name	The child name (can also be a path separating the elements with '.' or '$')

GetElement()

MmsVariableSpecification IEC61850.Common.MmsVariableSpecification.GetElement

(

int

index

)

Gets the element specification of a structure element

Returns

The element of the structure at given index

Parameters

index

Index.

GetName()

string IEC61850.Common.MmsVariableSpecification.GetName

(

)

Gets the name of the variable

Returns

The name.

GetType()

new MmsType IEC61850.Common.MmsVariableSpecification.GetType

(

)

Gets the MmsValue type of the variable

Returns

The MmsType of the variable

IsValueOfType()

bool IEC61850.Common.MmsVariableSpecification.IsValueOfType

(

MmsValue

value

)

Determines whether the given value object matches this type

Returns

true if the value matches this type; otherwise, false.

Parameters

value

the value to test.

Size()

int IEC61850.Common.MmsVariableSpecification.Size

(

)

Get the "size" of the variable (array size, number of structure elements ...)

---

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

• /home/mzillgit/workspace-git/bitbucket/mz-automation/libiec61850/dotnet/IEC61850forCSharp/MmsVariableSpecification.cs