https://reference.opcfoundation.org/v105/Core/docs/Part18/4.4.1 More...

Inherits UnifiedAutomation.UaServer.BaseObjectModel, UnifiedAutomation.UaServer.IMethodDispatcher, and UnifiedAutomation.UaServer.IRoleMethods.

Public Member Functions

StatusCode AddApplication (RequestContext context, RoleModel model, string ApplicationUri)

This Method is used to add an application mapping rule to a Role. More...

StatusCode AddEndpoint (RequestContext context, RoleModel model, EndpointType Endpoint)

This Method is used to add an endpoint mapping rule to a Role. More...

StatusCode AddIdentity (RequestContext context, RoleModel model, IdentityMappingRuleType Rule)

This Method is used to add an identity mapping rule to a Role. More...

StatusCode RemoveApplication (RequestContext context, RoleModel model, string ApplicationUri)

This Method is used to remove an application mapping rule from a Role. More...

StatusCode RemoveEndpoint (RequestContext context, RoleModel model, EndpointType Endpoint)

This Method is used to remove an endpoint mapping rule from a Role. More...

StatusCode RemoveIdentity (RequestContext context, RoleModel model, IdentityMappingRuleType Rule)

This Method is used to remove an identity mapping rule from a Role. More...

RoleModel ()

Initializes a new instance of the RoleModel class. More...

RoleModel (RoleModel template, DummyArgument dummy=null)

Initializes a new instance of the RoleModel class. More...

virtual CallMethodEventHandler GetMethodDispatcher (RequestContext context, NodeId objectId, NodeId methodId)

Gets the method dispatcher. More...

virtual StatusCode DispatchMethod (RequestContext context, MethodHandle methodHandle, IList< Variant > inputArguments, List< StatusCode > inputArgumentResults, List< Variant > outputArguments)

Dispatches the method. More...

Public Member Functions inherited from UnifiedAutomation.UaServer.BaseObjectModel

BaseObjectModel ()

Initializes a new instance of the BaseObjectModel class. More...

BaseObjectModel (BaseObjectModel template, DummyArgument dummy=null)

Initializes a new instance of the BaseObjectModel class. More...

Public Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase

virtual ModelHandle GetModelHandle (StringTable namespaceUris, object instance)

Gets the metadata handle. More...

virtual DataValue GetValue (IMapperContext context, ModelMapping mapping)

Gets the value associated with the mapping. More...

virtual bool SetValue (IMapperContext context, ModelMapping mapping, DataValue value)

Sets the value associated with the mapping. More...

StatusCode GetStatusCode (string propertyName)

Retrieve the status code for the given property. If no status code was explicitly set, StatusCodes.Good will be returned.

Parameters

propertyName The property name.

Returns: The status code of the property.

void SetStatusCode (string propertyName, StatusCode statusCode)

Sets the status code of the given property. More...

Protected Member Functions
virtual bool	IsAdminRole ()
	Return whether role is an admin role. More...

Protected Member Functions inherited from UnifiedAutomation.UaServer.ModelControllerBase
void	RaisePropertyChangedEvent ([CallerMemberName] string propertyName=null)
	Raises an property change event. More...

void	RaisePropertyChangeRequestedEvent< T > (T value, [CallerMemberName] string propertyName=null)
	Called when the value of a property is supposed to be changed. More...

bool	SetField< T > (ref T field, T value, [CallerMemberName] string propertyName=null)
	Sets the backing field to the new value, and triggers a property change event, if the value has changed. More...

Properties
UaSchema.RoleType	RoleType `[get, set]`
	The RoleType from the configuration. More...

ServerManager	ServerManager `[get, set]`
	The ServerManager is used to persist the configuration. More...

uint	Id `[get, set]`
	The internal optimized handle for the Role. More...

string[]	Applications `[get, set]`
	Gets or sets the Applications More...

bool	ApplicationsExclude `[get, set]`
	Gets or sets the ApplicationsExclude More...

bool	CustomConfiguration `[get, set]`
	Gets or sets the CustomConfiguration More...

EndpointType[]	Endpoints `[get, set]`
	Gets or sets the Endpoints More...

bool	EndpointsExclude `[get, set]`
	Gets or sets the EndpointsExclude More...

IdentityMappingRuleType[]	Identities `[get, set]`
	Gets or sets the Identities More...

IRoleMethods	RoleMethods `[get, set]`
	Gets or sets the Role methods. More...

Properties inherited from UnifiedAutomation.UaServer.ModelControllerBase
ModelHandle	ModelHandle `[get, set]`
	Gets or sets the metadata handle. More...

object	UserData `[get, set]`
	Gets or sets the user data. More...

Properties inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
bool	HasStatusCodes `[get]`
	`true` if no property has an explicit set status code. Hence when all status codes are implicit StatusCodes.Good. More...

Additional Inherited Members
Public Attributes inherited from UnifiedAutomation.UaServer.ModelControllerBase
bool	HasStatusCodes => m_statusCodes != null && m_statusCodes.Count > 0

Events inherited from UnifiedAutomation.UaServer.ModelControllerBase
PropertyChangedEventHandler	PropertyChanged
	Occurs when a property value changes. More...

EventHandler < PropertyChangeRequestedEventArgs >	PropertyChangeRequested
	The event is emitted just before the value will be changed, and gives the observer the opportunity to reject or adjust (e.g. clamp) the property change by setting the PropertyChangeRequestedEventArgs.StatusCode and PropertyChangeRequestedEventArgs.Value properties. More...

EventHandler < StatusCodeChangedEventArgs >	StatusCodeChanged

Events inherited from UnifiedAutomation.UaServer.INotifyPropertyChangeRequested
EventHandler < PropertyChangeRequestedEventArgs >	PropertyChangeRequested
	The property change request event. More...

Events inherited from UnifiedAutomation.UaServer.INotifyStatusCodeInfo
EventHandler < StatusCodeChangedEventArgs >	StatusCodeChanged
	Occurs if the status code of a property was changed. More...

Detailed Description

https://reference.opcfoundation.org/v105/Core/docs/Part18/4.4.1

Constructor & Destructor Documentation

UnifiedAutomation.UaServer.RoleModel.RoleModel ( )

Initializes a new instance of the RoleModel class.

UnifiedAutomation.UaServer.RoleModel.RoleModel	(	RoleModel	template,
		DummyArgument	dummy = `null`
	)

Initializes a new instance of the RoleModel class.

Parameters

template	The template.
dummy	Dummy argument to enable writing own constructors that are called by the generated code.

Member Function Documentation

StatusCode UnifiedAutomation.UaServer.RoleModel.AddApplication	(	RequestContext	context,
		RoleModel	model,
		string	ApplicationUri
	)

This Method is used to add an application mapping rule to a Role.

Implements UnifiedAutomation.UaServer.IRoleMethods.

StatusCode UnifiedAutomation.UaServer.RoleModel.AddEndpoint	(	RequestContext	context,
		RoleModel	model,
		EndpointType	Endpoint
	)

This Method is used to add an endpoint mapping rule to a Role.

Implements UnifiedAutomation.UaServer.IRoleMethods.

StatusCode UnifiedAutomation.UaServer.RoleModel.AddIdentity	(	RequestContext	context,
		RoleModel	model,
		IdentityMappingRuleType	Rule
	)

This Method is used to add an identity mapping rule to a Role.

Implements UnifiedAutomation.UaServer.IRoleMethods.

virtual StatusCode UnifiedAutomation.UaServer.RoleModel.DispatchMethod	(	RequestContext	context,
		MethodHandle	methodHandle,
		IList< Variant >	inputArguments,
		List< StatusCode >	inputArgumentResults,
		List< Variant >	outputArguments
	)

virtual

Dispatches the method.

Parameters

context	The context.
methodHandle	The method handle.
inputArguments	The input arguments.
inputArgumentResults	The input argument results.
outputArguments	The output arguments.

Returns

virtual CallMethodEventHandler UnifiedAutomation.UaServer.RoleModel.GetMethodDispatcher	(	RequestContext	context,
		NodeId	objectId,
		NodeId	methodId
	)

virtual

Gets the method dispatcher.

Parameters

context	The context.
objectId	The object id.
methodId	The method id.

Returns

Implements UnifiedAutomation.UaServer.IMethodDispatcher.

virtual bool UnifiedAutomation.UaServer.RoleModel.IsAdminRole ( )

protectedvirtual

Return whether role is an admin role.

The default implementation returns 'true' for the WellKnownRoles ConfigureAdmin and SecurityAdmin.

This method is called in AddIdentity.

Returns

StatusCode UnifiedAutomation.UaServer.RoleModel.RemoveApplication	(	RequestContext	context,
		RoleModel	model,
		string	ApplicationUri
	)

This Method is used to remove an application mapping rule from a Role.

Implements UnifiedAutomation.UaServer.IRoleMethods.

StatusCode UnifiedAutomation.UaServer.RoleModel.RemoveEndpoint	(	RequestContext	context,
		RoleModel	model,
		EndpointType	Endpoint
	)

This Method is used to remove an endpoint mapping rule from a Role.

Implements UnifiedAutomation.UaServer.IRoleMethods.

StatusCode UnifiedAutomation.UaServer.RoleModel.RemoveIdentity	(	RequestContext	context,
		RoleModel	model,
		IdentityMappingRuleType	Rule
	)

This Method is used to remove an identity mapping rule from a Role.

Returns

Implements UnifiedAutomation.UaServer.IRoleMethods.

Property Documentation

string [] UnifiedAutomation.UaServer.RoleModel.Applications

getset

Gets or sets the Applications

bool UnifiedAutomation.UaServer.RoleModel.ApplicationsExclude

getset

Gets or sets the ApplicationsExclude

bool UnifiedAutomation.UaServer.RoleModel.CustomConfiguration

getset

Gets or sets the CustomConfiguration

EndpointType [] UnifiedAutomation.UaServer.RoleModel.Endpoints

getset

Gets or sets the Endpoints

bool UnifiedAutomation.UaServer.RoleModel.EndpointsExclude

getset

Gets or sets the EndpointsExclude

uint UnifiedAutomation.UaServer.RoleModel.Id

getset

The internal optimized handle for the Role.

IdentityMappingRuleType [] UnifiedAutomation.UaServer.RoleModel.Identities

getset

Gets or sets the Identities

IRoleMethods UnifiedAutomation.UaServer.RoleModel.RoleMethods

getset

Gets or sets the Role methods.

The Role methods.

UaSchema.RoleType UnifiedAutomation.UaServer.RoleModel.RoleType

getset

The RoleType from the configuration.

ServerManager UnifiedAutomation.UaServer.RoleModel.ServerManager

getset

The ServerManager is used to persist the configuration.

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

D:/work/uasdknet_master/src/UaServer/Controllers/RoleModel.cs
D:/work/uasdknet_master/src/UaServer/Models/UaBaseClasses.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation