C# Class Softing.OPCToolbox.Server.AeCategory

The AeCategory class implements an event category in the OPC AE Server. A category contains events or conditions of the same kind. They are also characterized by the fact that they can supply the same attributes to the OPC Client.

ファイルを表示 Open project: SoftingIndustrial/OPC-Classic-SDK

Protected Properties

Property	Type	Description
m_attributes	Hashtable
m_conditions	Hashtable
m_eventType	EnumEventType
m_id	uint
m_name	string

Private Properties

Property	Type	Description
AeCategory	System

Public Methods

Method	Description
AddAttribute ( uint anId, string aName, Type aDataType ) : int	Creates and adds a new attribute to the category hashtable.
AddConditionDefinition ( string aConditionName ) : int	adds a new condition definition object with the name provided as aConditionDefinition
AddSubConditionDefinition ( string aConditionName, string aSubconditionName ) : int	Adds a subcondition to a condition in the AeCategory.
AeCategory ( EnumEventType anEventType, uint anId, string aName ) : System	Category constructor
GetConditionDefinition ( string aConditionName ) : Softing.OPCToolbox.Server.AeConditionDefinition	retrieves the AeConditionDefinition associated to the aConditionName
GetSubConditionDefinition ( string aConditionName, string aSubconditionName ) : Softing.OPCToolbox.Server.AeSubConditionDefinition	returns the sub condition definition object for a specified condition and subcondition identifier

Protected Methods

Method	Description
AddAttribute ( AeAttribute anAttribute ) : int	Adds an existing attribute object to the category internal hashtable

Private Methods

Method	Description
AeCategory ( EnumEventType anEventType, uint anId, string aName, uint aHandle ) : System	Internal constructor. may be only called from witin the TBN asembly

Method Details

AddAttribute() protected method

Adds an existing attribute object to the category internal hashtable

protected AddAttribute ( AeAttribute anAttribute ) : int
anAttribute	AeAttribute	an already created instance of the attribute
return	int

AddAttribute() public method

Creates and adds a new attribute to the category hashtable.

public AddAttribute ( uint anId, string aName, Type aDataType ) : int
anId	uint	new attribute ID
aName	string	new attribute
aDataType	Type
return	int

AddConditionDefinition() public method

adds a new condition definition object with the name provided as aConditionDefinition

public AddConditionDefinition ( string aConditionName ) : int
aConditionName	string	the condition name
return	int

AddSubConditionDefinition() public method

Adds a subcondition to a condition in the AeCategory.

public AddSubConditionDefinition ( string aConditionName, string aSubconditionName ) : int
aConditionName	string	The existing condition.
aSubconditionName	string	New subcondition name.
return	int

AeCategory() public method

Category constructor

public AeCategory ( EnumEventType anEventType, uint anId, string aName ) : System
anEventType	EnumEventType	the type of event
anId	uint	unique integer identifier of a category
aName	string	the category name
return	System

GetConditionDefinition() public method

retrieves the AeConditionDefinition associated to the aConditionName

public GetConditionDefinition ( string aConditionName ) : Softing.OPCToolbox.Server.AeConditionDefinition
aConditionName	string	/// the name of the condition definition to be found ///
return	Softing.OPCToolbox.Server.AeConditionDefinition

GetSubConditionDefinition() public method

returns the sub condition definition object for a specified condition and subcondition identifier

public GetSubConditionDefinition ( string aConditionName, string aSubconditionName ) : Softing.OPCToolbox.Server.AeSubConditionDefinition
aConditionName	string	/// The condition identifier where the needed subcondition lays ///
aSubconditionName	string	/// the id of the subcondition needed ///
return	Softing.OPCToolbox.Server.AeSubConditionDefinition

Property Details

m_attributes protected_oe property

List of attributes types

protected Hashtable m_attributes
return	Hashtable

m_conditions protected_oe property

list of conditions associated to this category

protected Hashtable m_conditions
return	Hashtable

m_eventType protected_oe property

The type of the events that will be generated by this AeCategory

protected EnumEventType m_eventType
return	EnumEventType

m_id protected_oe property

Unique identifier for the instantiated Category. The Category Id must be specified when object created.

protected uint m_id
return	uint

m_name protected_oe property

The condition's name

protected string m_name
return	string