C# Class Softing.OPCToolbox.Server.Creator

Helper class used as factory for various object instances of the OPC server components. This class is used by the Toolkit internal mechanisms to instantiate user specific objects. To enable this, the user must extend the Creator class and override the create methods.

Afficher le fichier Open project: SoftingIndustrial/OPC-Classic-SDK

Méthodes publiques

Méthode	Description
CreateAeAddressSpaceElement ( ) : Softing.OPCToolbox.Server.AeAddressSpaceElement	Creates the AeAddressSpaceElement instance. This method should be overriden when a custom root is wanted.
CreateAeAddressSpaceRoot ( ) : Softing.OPCToolbox.Server.AeAddressSpaceRoot	Creates the AeAddressSpaceRoot instance
CreateDaAddressSpaceElement ( ) : Softing.OPCToolbox.Server.DaAddressSpaceElement	Creates the DaAddressSpaceElement instance. This method should be overriden when a custom root is wanted.
CreateDaAddressSpaceRoot ( ) : Softing.OPCToolbox.Server.DaAddressSpaceRoot	Creates the DaAddressSpaceRoot instance. This method should be overriden when a custom root is wanted.
CreateInternalAeAddressSpaceElement ( string aName, uint anUserData, uint anObjectHandle, uint aParentHandle ) : Softing.OPCToolbox.Server.AeAddressSpaceElement	Creates a new instance of AddressSpaceElement for string based address space only
CreateInternalDaAddressSpaceElement ( string anItemId, string aName, uint anUserData, uint anObjectHandle, uint aParentHandle ) : Softing.OPCToolbox.Server.DaAddressSpaceElement	Creates a new instance of DaAddressSpaceElement for string based address space only
CreateInternalDaAddressSpaceElementEx ( string anItemId, string aName, uint anUserData, uint anObjectHandle, uint aParentHandle, EnumAddressSpaceElementData elementDataFilter, EnumAccessRights accessRights, EnumIoMode ioMode, bool hasChildren, bool isBrowsable, Type dataType ) : Softing.OPCToolbox.Server.DaAddressSpaceElement	Creates a new instance of DaAddressSpaceElement for string based address space only (extended version). Must return a valid DaAddressSpaceElement object in order to have the Toolkit CORE use this extended method. If CreateInternalDaAddressSpaceElementEx method is correctly implemented, CreateInternalDaAddressSpaceElement will be ignored (will never be called unless CreateInternalDaAddressSpaceElementEx fails.
CreateRequest ( EnumTransactionType aTransactionType, uint aSessionHandle, Softing.OPCToolbox.Server.DaAddressSpaceElement anElement, int aPropertyId, uint aRequestHandle ) : DaRequest	Toolkit internal creator of a DaRequest. By overloading this method, the user can determine creation of custom Request objects.
CreateSession ( EnumSessionType aType, uint aHandle ) : Softing.OPCToolbox.Server.DaSession	Toolkit internal creator of a DaSession. By overloading this method, the user can determine creation of custom Session objects. The number of connected clients can be limited. This can be achieved by returning null instead of a new instance of the DaSession class if the number of clients exceeds a desired number.
CreateTransaction ( EnumTransactionType aTransactionType, Array aRequests, uint aSessionKey ) : Softing.OPCToolbox.Server.DaTransaction	Toolkit internal creator of a DaTransaction. By overloading this method, the user can determine creation of custom Transaction objects. All parameters should be forwarded directly to the custom Transaction class.
CreateWebTemplate ( ) : WebTemplate	Toolkit internal creator of a WebTemplate. By overloading this method, the user can determine creation of a custom WebTemplate handler instance. If web sever is used, this method shuld be overloaded

Method Details

CreateAeAddressSpaceElement() public méthode

Creates the AeAddressSpaceElement instance. This method should be overriden when a custom root is wanted.

public CreateAeAddressSpaceElement ( ) : Softing.OPCToolbox.Server.AeAddressSpaceElement
Résultat	Softing.OPCToolbox.Server.AeAddressSpaceElement

CreateAeAddressSpaceRoot() public méthode

Creates the AeAddressSpaceRoot instance

public CreateAeAddressSpaceRoot ( ) : Softing.OPCToolbox.Server.AeAddressSpaceRoot
Résultat	Softing.OPCToolbox.Server.AeAddressSpaceRoot

CreateDaAddressSpaceElement() public méthode

Creates the DaAddressSpaceElement instance. This method should be overriden when a custom root is wanted.

public CreateDaAddressSpaceElement ( ) : Softing.OPCToolbox.Server.DaAddressSpaceElement
Résultat	Softing.OPCToolbox.Server.DaAddressSpaceElement

CreateDaAddressSpaceRoot() public méthode

Creates the DaAddressSpaceRoot instance. This method should be overriden when a custom root is wanted.

public CreateDaAddressSpaceRoot ( ) : Softing.OPCToolbox.Server.DaAddressSpaceRoot
Résultat	Softing.OPCToolbox.Server.DaAddressSpaceRoot

CreateInternalAeAddressSpaceElement() public méthode

Creates a new instance of AddressSpaceElement for string based address space only

public CreateInternalAeAddressSpaceElement ( string aName, uint anUserData, uint anObjectHandle, uint aParentHandle ) : Softing.OPCToolbox.Server.AeAddressSpaceElement
aName	string
anUserData	uint
anObjectHandle	uint
aParentHandle	uint
Résultat	Softing.OPCToolbox.Server.AeAddressSpaceElement

CreateInternalDaAddressSpaceElement() public méthode

Creates a new instance of DaAddressSpaceElement for string based address space only

public CreateInternalDaAddressSpaceElement ( string anItemId, string aName, uint anUserData, uint anObjectHandle, uint aParentHandle ) : Softing.OPCToolbox.Server.DaAddressSpaceElement
anItemId	string	Item ID of the element to be created
aName	string	Iten name of the element to be created
anUserData	uint	User data for the element to be created
anObjectHandle	uint	Toolkit CORE object handle of the element to be created
aParentHandle	uint	Toolkit CORE object handle of the parent of the element to be created
Résultat	Softing.OPCToolbox.Server.DaAddressSpaceElement

CreateInternalDaAddressSpaceElementEx() public méthode

Creates a new instance of DaAddressSpaceElement for string based address space only (extended version).
Must return a valid DaAddressSpaceElement object in order to have the Toolkit CORE use this extended method.
If CreateInternalDaAddressSpaceElementEx method is correctly implemented, CreateInternalDaAddressSpaceElement will be ignored (will never be called unless CreateInternalDaAddressSpaceElementEx fails.

public CreateInternalDaAddressSpaceElementEx ( string anItemId, string aName, uint anUserData, uint anObjectHandle, uint aParentHandle, EnumAddressSpaceElementData elementDataFilter, EnumAccessRights accessRights, EnumIoMode ioMode, bool hasChildren, bool isBrowsable, Type dataType ) : Softing.OPCToolbox.Server.DaAddressSpaceElement
anItemId	string	Item ID of the element to be created
aName	string	Iten name of the element to be created
anUserData	uint	User data for the element to be created
anObjectHandle	uint	Toolkit CORE object handle of the element to be created
aParentHandle	uint	Toolkit CORE object handle of the parent of the element to be created
elementDataFilter	EnumAddressSpaceElementData	Type of element data which is not set in the parameters below
accessRights	EnumAccessRights	Element`s access rights, valid if flag is not set in elementDataFilter
ioMode	EnumIoMode	Element`s IO mode, valid if is not set in elementDataFilter
hasChildren	bool	Whether the element has children or not (is node or tag), valid if is not set in elementDataFilter
isBrowsable	bool	Whether the elementis browsable, valid if is not set in elementDataFilter
dataType	Type	Element`s data type, valid if flag is not set in elementDataFilter
Résultat	Softing.OPCToolbox.Server.DaAddressSpaceElement

CreateRequest() public méthode

Toolkit internal creator of a DaRequest. By overloading this method, the user can determine creation of custom Request objects.

public CreateRequest ( EnumTransactionType aTransactionType, uint aSessionHandle, Softing.OPCToolbox.Server.DaAddressSpaceElement anElement, int aPropertyId, uint aRequestHandle ) : DaRequest
aTransactionType	EnumTransactionType
aSessionHandle	uint
anElement	Softing.OPCToolbox.Server.DaAddressSpaceElement
aPropertyId	int
aRequestHandle	uint
Résultat	DaRequest

CreateSession() public méthode

Toolkit internal creator of a DaSession. By overloading this method, the user can determine creation of custom Session objects. The number of connected clients can be limited. This can be achieved by returning null instead of a new instance of the DaSession class if the number of clients exceeds a desired number.

public CreateSession ( EnumSessionType aType, uint aHandle ) : Softing.OPCToolbox.Server.DaSession
aType	EnumSessionType
aHandle	uint
Résultat	Softing.OPCToolbox.Server.DaSession

CreateTransaction() public méthode

Toolkit internal creator of a DaTransaction. By overloading this method, the user can determine creation of custom Transaction objects. All parameters should be forwarded directly to the custom Transaction class.

public CreateTransaction ( EnumTransactionType aTransactionType, Array aRequests, uint aSessionKey ) : Softing.OPCToolbox.Server.DaTransaction
aTransactionType	EnumTransactionType
aRequests	Array
aSessionKey	uint
Résultat	Softing.OPCToolbox.Server.DaTransaction

CreateWebTemplate() public méthode

Toolkit internal creator of a WebTemplate. By overloading this method, the user can determine creation of a custom WebTemplate handler instance. If web sever is used, this method shuld be overloaded

public CreateWebTemplate ( ) : WebTemplate
Résultat	WebTemplate