C# Class Opc.Ua.MethodState

The base class for all method nodes.

Inheritance: BaseInstanceState

ファイルを表示 Open project: OPCFoundation/UA-.NETStandardLibrary Class Usage Examples

Public Properties

Property	Type	Description
OnCallMethod	GenericMethodCalledEventHandler
OnCallMethod2	GenericMethodCalledEventHandler2
OnReadExecutable	NodeAttributeEventHandler
OnReadUserExecutable	NodeAttributeEventHandler
OnWriteExecutable	NodeAttributeEventHandler
OnWriteUserExecutable	NodeAttributeEventHandler

Public Methods

Method	Description
Call ( ISystemContext context, Opc.Ua.NodeId objectId, IList inputArguments, IList argumentErrors, IList outputArguments ) : ServiceResult	Invokes the methods and returns the output parameters.
Construct ( NodeState parent ) : NodeState	Constructs an instance of a node.
GetAttributesToSave ( ISystemContext context ) : AttributesToSave	Returns a mask which indicates which attributes have non-default value.
GetChildren ( ISystemContext context, IList children ) : void	Populates a list with the children that belong to the node.
MethodState ( NodeState parent ) : System	Initializes the instance with its defalt attribute values.
Save ( ISystemContext context, BinaryEncoder encoder, AttributesToSave attributesToSave ) : void	Saves object in an binary stream.
Save ( ISystemContext context, XmlEncoder encoder ) : void	Saves the attributes from the stream.
Update ( ISystemContext context, BinaryDecoder decoder, AttributesToSave attibutesToLoad ) : void	Updates the specified context.
Update ( ISystemContext context, XmlDecoder decoder ) : void	Updates the attributes from the stream.

Protected Methods

Method	Description
Call ( ISystemContext context, IList	Invokes the method, returns the result and output argument.
Call ( ISystemContext context, Opc.Ua.NodeId objectId, IList	Invokes the method, returns the result and output argument.
Export ( ISystemContext context, Node node ) : void	Exports a copt of the node to a node table.
FindChild ( ISystemContext context, Opc.Ua.QualifiedName browseName, bool createOrReplace, BaseInstanceState replacement ) : BaseInstanceState	Finds the child with the specified browse name.
GetArgumentDefaultValue ( ISystemContext context, Argument outputArgument ) : object	Returns the default value for the output argument.
Initialize ( ISystemContext context ) : void	Initializes the instance with the default values.
Initialize ( ISystemContext context, NodeState source ) : void	Initializes the instance from another instance.
ReadNonValueAttribute ( ISystemContext context, uint attributeId, object &value ) : ServiceResult	Reads the value for any non-value attribute.
ValidateInputArgument ( ISystemContext context, Variant inputArgument, int index ) : ServiceResult	Validates the input argument.
WriteNonValueAttribute ( ISystemContext context, uint attributeId, object value ) : ServiceResult	Write the value for any non-value attribute.

Method Details

Call() protected method

Invokes the method, returns the result and output argument.

protected Call ( ISystemContext context, IList
context	ISystemContext
inputArguments	IList
outputArguments	IList
return	ServiceResult

Call() public method

Invokes the methods and returns the output parameters.

public Call ( ISystemContext context, Opc.Ua.NodeId objectId, IList inputArguments, IList argumentErrors, IList outputArguments ) : ServiceResult
context	ISystemContext	The context to use.
objectId	Opc.Ua.NodeId	The object being called.
inputArguments	IList	The input arguments.
argumentErrors	IList	Any errors for the input arguments.
outputArguments	IList	The output arguments.
return	ServiceResult

Call() protected method

Invokes the method, returns the result and output argument.

protected Call ( ISystemContext context, Opc.Ua.NodeId objectId, IList
context	ISystemContext	The current context.
objectId	Opc.Ua.NodeId	The id of the object.
inputArguments	IList	The input arguments which have been already validated.
outputArguments	IList	The output arguments which have initialized with thier default values.
return	ServiceResult

Construct() public static method

Constructs an instance of a node.

public static Construct ( NodeState parent ) : NodeState
parent	NodeState	The parent.
return	NodeState

Export() protected method

Exports a copt of the node to a node table.

protected Export ( ISystemContext context, Node node ) : void
context	ISystemContext	The context.
node	Node	The node.
return	void

FindChild() protected method

Finds the child with the specified browse name.

protected FindChild ( ISystemContext context, Opc.Ua.QualifiedName browseName, bool createOrReplace, BaseInstanceState replacement ) : BaseInstanceState
context	ISystemContext
browseName	Opc.Ua.QualifiedName
createOrReplace	bool
replacement	BaseInstanceState
return	BaseInstanceState

GetArgumentDefaultValue() protected method

Returns the default value for the output argument.

protected GetArgumentDefaultValue ( ISystemContext context, Argument outputArgument ) : object
context	ISystemContext	The context to use.
outputArgument	Argument	The output argument description.
return	object

GetAttributesToSave() public method

Returns a mask which indicates which attributes have non-default value.

public GetAttributesToSave ( ISystemContext context ) : AttributesToSave
context	ISystemContext	The context for the system being accessed.
return	AttributesToSave

GetChildren() public method

Populates a list with the children that belong to the node.

public GetChildren ( ISystemContext context, IList children ) : void
context	ISystemContext	The context for the system being accessed.
children	IList	The list of children to populate.
return	void

Initialize() protected method

Initializes the instance with the default values.

protected Initialize ( ISystemContext context ) : void
context	ISystemContext
return	void

Initialize() protected method

Initializes the instance from another instance.

protected Initialize ( ISystemContext context, NodeState source ) : void
context	ISystemContext
source	NodeState
return	void

MethodState() public method

Initializes the instance with its defalt attribute values.

public MethodState ( NodeState parent ) : System
parent	NodeState
return	System

ReadNonValueAttribute() protected method

Reads the value for any non-value attribute.

protected ReadNonValueAttribute ( ISystemContext context, uint attributeId, object &value ) : ServiceResult
context	ISystemContext
attributeId	uint
value	object
return	ServiceResult

Save() public method

Saves object in an binary stream.

public Save ( ISystemContext context, BinaryEncoder encoder, AttributesToSave attributesToSave ) : void
context	ISystemContext	The context user.
encoder	BinaryEncoder	The encoder to write to.
attributesToSave	AttributesToSave	The masks indicating what attributes to write.
return	void

Save() public method

Saves the attributes from the stream.

public Save ( ISystemContext context, XmlEncoder encoder ) : void
context	ISystemContext	The context for the system being accessed.
encoder	XmlEncoder	The encoder wrapping the stream to write.
return	void

Update() public method

Updates the specified context.

public Update ( ISystemContext context, BinaryDecoder decoder, AttributesToSave attibutesToLoad ) : void
context	ISystemContext	The context.
decoder	BinaryDecoder	The decoder.
attibutesToLoad	AttributesToSave	The attributes to load.
return	void

Update() public method

Updates the attributes from the stream.

public Update ( ISystemContext context, XmlDecoder decoder ) : void
context	ISystemContext	The context for the system being accessed.
decoder	XmlDecoder	The decoder wrapping the stream to read.
return	void

ValidateInputArgument() protected method

Validates the input argument.

protected ValidateInputArgument ( ISystemContext context, Variant inputArgument, int index ) : ServiceResult
context	ISystemContext	The context to use.
inputArgument	Variant	The input argument.
index	int	The index in the the list of input argument.
return	ServiceResult

WriteNonValueAttribute() protected method

Write the value for any non-value attribute.

protected WriteNonValueAttribute ( ISystemContext context, uint attributeId, object value ) : ServiceResult
context	ISystemContext
attributeId	uint
value	object
return	ServiceResult

Property Details

OnCallMethod public_oe property

Raised when the method is called.

public GenericMethodCalledEventHandler OnCallMethod
return	GenericMethodCalledEventHandler

OnCallMethod2 public_oe property

Raised when the method is called.

public GenericMethodCalledEventHandler2 OnCallMethod2
return	GenericMethodCalledEventHandler2

OnReadExecutable public_oe property

Raised when the Executable attribute is read.

public NodeAttributeEventHandler OnReadExecutable
return	NodeAttributeEventHandler

OnReadUserExecutable public_oe property

Raised when the UserExecutable attribute is read.

public NodeAttributeEventHandler OnReadUserExecutable
return	NodeAttributeEventHandler

OnWriteExecutable public_oe property

Raised when the Executable attribute is written.

public NodeAttributeEventHandler OnWriteExecutable
return	NodeAttributeEventHandler

OnWriteUserExecutable public_oe property

Raised when the UserExecutable attribute is written.

public NodeAttributeEventHandler OnWriteUserExecutable
return	NodeAttributeEventHandler