C++ Based OPC UA Client/Server/PubSub SDK  1.7.6.537
OpcUa::HistoryServerCapabilitiesType Class Reference

Class implementing the UaObject interface for the HistoryServerCapabilitiesType. More...

#include <opcua_historyservercapabilitiestype.h>

Inherits OpcUa::BaseObjectType.

Public Member Functions

 HistoryServerCapabilitiesType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class HistoryServerCapabilitiesType. More...
 
 HistoryServerCapabilitiesType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class HistoryServerCapabilitiesType. More...
 
virtual UaNodeId typeDefinitionId () const
 Returns the type definition NodeId for the HistoryServerCapabilitiesType.
 
void createDefaultAggregateFunctions ()
 Create the default aggregate function type objects to indicate the supported aggregates.
 
virtual void setAccessHistoryDataCapability (OpcUa_Boolean AccessHistoryDataCapability)
 Sets the AccessHistoryDataCapability value. More...
 
virtual OpcUa_Boolean getAccessHistoryDataCapability () const
 Returns the value of AccessHistoryDataCapability. More...
 
virtual void setAccessHistoryEventsCapability (OpcUa_Boolean AccessHistoryEventsCapability)
 Sets the AccessHistoryEventsCapability value. More...
 
virtual OpcUa_Boolean getAccessHistoryEventsCapability () const
 Returns the value of AccessHistoryEventsCapability. More...
 
virtual void setDeleteAtTimeCapability (OpcUa_Boolean DeleteAtTimeCapability)
 Sets the DeleteAtTimeCapability value. More...
 
virtual OpcUa_Boolean getDeleteAtTimeCapability () const
 Returns the value of DeleteAtTimeCapability. More...
 
virtual void setDeleteEventCapability (OpcUa_Boolean DeleteEventCapability)
 Sets the DeleteEventCapability value. More...
 
virtual OpcUa_Boolean getDeleteEventCapability () const
 Returns the value of DeleteEventCapability. More...
 
virtual void setDeleteRawCapability (OpcUa_Boolean DeleteRawCapability)
 Sets the DeleteRawCapability value. More...
 
virtual OpcUa_Boolean getDeleteRawCapability () const
 Returns the value of DeleteRawCapability. More...
 
virtual void setInsertAnnotationCapability (OpcUa_Boolean InsertAnnotationCapability)
 Sets the InsertAnnotationCapability value. More...
 
virtual OpcUa_Boolean getInsertAnnotationCapability () const
 Returns the value of InsertAnnotationCapability. More...
 
virtual void setInsertDataCapability (OpcUa_Boolean InsertDataCapability)
 Sets the InsertDataCapability value. More...
 
virtual OpcUa_Boolean getInsertDataCapability () const
 Returns the value of InsertDataCapability. More...
 
virtual void setInsertEventCapability (OpcUa_Boolean InsertEventCapability)
 Sets the InsertEventCapability value. More...
 
virtual OpcUa_Boolean getInsertEventCapability () const
 Returns the value of InsertEventCapability. More...
 
virtual void setMaxReturnDataValues (OpcUa_UInt32 MaxReturnDataValues)
 Sets the MaxReturnDataValues value. More...
 
virtual OpcUa_UInt32 getMaxReturnDataValues () const
 Returns the value of MaxReturnDataValues. More...
 
virtual void setMaxReturnEventValues (OpcUa_UInt32 MaxReturnEventValues)
 Sets the MaxReturnEventValues value. More...
 
virtual OpcUa_UInt32 getMaxReturnEventValues () const
 Returns the value of MaxReturnEventValues. More...
 
virtual void setReplaceDataCapability (OpcUa_Boolean ReplaceDataCapability)
 Sets the ReplaceDataCapability value. More...
 
virtual OpcUa_Boolean getReplaceDataCapability () const
 Returns the value of ReplaceDataCapability. More...
 
virtual void setReplaceEventCapability (OpcUa_Boolean ReplaceEventCapability)
 Sets the ReplaceEventCapability value. More...
 
virtual OpcUa_Boolean getReplaceEventCapability () const
 Returns the value of ReplaceEventCapability. More...
 
virtual void setServerTimestampSupported (OpcUa_Boolean ServerTimestampSupported)
 Sets the ServerTimestampSupported value.
 
virtual OpcUa_Boolean getServerTimestampSupported () const
 Returns the value of ServerTimestampSupported.
 
virtual void setUpdateDataCapability (OpcUa_Boolean UpdateDataCapability)
 Sets the UpdateDataCapability value. More...
 
virtual OpcUa_Boolean getUpdateDataCapability () const
 Returns the value of UpdateDataCapability. More...
 
virtual void setUpdateEventCapability (OpcUa_Boolean UpdateEventCapability)
 Sets the UpdateEventCapability value. More...
 
virtual OpcUa_Boolean getUpdateEventCapability () const
 Returns the value of UpdateEventCapability. More...
 
virtual OpcUa::PropertyTypegetAccessHistoryDataCapabilityNode ()
 Returns the AccessHistoryDataCapability node. More...
 
virtual const OpcUa::PropertyTypegetAccessHistoryDataCapabilityNode () const
 Returns the AccessHistoryDataCapability node. More...
 
virtual OpcUa::PropertyTypegetAccessHistoryEventsCapabilityNode ()
 Returns the AccessHistoryEventsCapability node. More...
 
virtual const OpcUa::PropertyTypegetAccessHistoryEventsCapabilityNode () const
 Returns the AccessHistoryEventsCapability node. More...
 
virtual OpcUa::FolderTypegetAggregateFunctions ()
 Returns the AggregateFunctions node. More...
 
virtual const OpcUa::FolderTypegetAggregateFunctions () const
 Returns the AggregateFunctions node. More...
 
virtual OpcUa::PropertyTypegetDeleteAtTimeCapabilityNode ()
 Returns the DeleteAtTimeCapability node. More...
 
virtual const OpcUa::PropertyTypegetDeleteAtTimeCapabilityNode () const
 Returns the DeleteAtTimeCapability node. More...
 
virtual OpcUa::PropertyTypegetDeleteEventCapabilityNode ()
 Returns the DeleteEventCapability node. More...
 
virtual const OpcUa::PropertyTypegetDeleteEventCapabilityNode () const
 Returns the DeleteEventCapability node. More...
 
virtual OpcUa::PropertyTypegetDeleteRawCapabilityNode ()
 Returns the DeleteRawCapability node. More...
 
virtual const OpcUa::PropertyTypegetDeleteRawCapabilityNode () const
 Returns the DeleteRawCapability node. More...
 
virtual OpcUa::PropertyTypegetInsertAnnotationCapabilityNode ()
 Returns the InsertAnnotationCapability node. More...
 
virtual const OpcUa::PropertyTypegetInsertAnnotationCapabilityNode () const
 Returns the InsertAnnotationCapability node. More...
 
virtual OpcUa::PropertyTypegetInsertDataCapabilityNode ()
 Returns the InsertDataCapability node. More...
 
virtual const OpcUa::PropertyTypegetInsertDataCapabilityNode () const
 Returns the InsertDataCapability node. More...
 
virtual OpcUa::PropertyTypegetInsertEventCapabilityNode ()
 Returns the InsertEventCapability node. More...
 
virtual const OpcUa::PropertyTypegetInsertEventCapabilityNode () const
 Returns the InsertEventCapability node. More...
 
virtual OpcUa::PropertyTypegetMaxReturnDataValuesNode ()
 Returns the MaxReturnDataValues node. More...
 
virtual const OpcUa::PropertyTypegetMaxReturnDataValuesNode () const
 Returns the MaxReturnDataValues node. More...
 
virtual OpcUa::PropertyTypegetMaxReturnEventValuesNode ()
 Returns the MaxReturnEventValues node. More...
 
virtual const OpcUa::PropertyTypegetMaxReturnEventValuesNode () const
 Returns the MaxReturnEventValues node. More...
 
virtual OpcUa::PropertyTypegetReplaceDataCapabilityNode ()
 Returns the ReplaceDataCapability node. More...
 
virtual const OpcUa::PropertyTypegetReplaceDataCapabilityNode () const
 Returns the ReplaceDataCapability node. More...
 
virtual OpcUa::PropertyTypegetReplaceEventCapabilityNode ()
 Returns the ReplaceEventCapability node. More...
 
virtual const OpcUa::PropertyTypegetReplaceEventCapabilityNode () const
 Returns the ReplaceEventCapability node. More...
 
virtual OpcUa::PropertyTypegetServerTimestampSupportedNode ()
 Returns the ServerTimestampSupported node.
 
virtual const OpcUa::PropertyTypegetServerTimestampSupportedNode () const
 Returns the ServerTimestampSupported node.
 
virtual OpcUa::PropertyTypegetUpdateDataCapabilityNode ()
 Returns the UpdateDataCapability node. More...
 
virtual const OpcUa::PropertyTypegetUpdateDataCapabilityNode () const
 Returns the UpdateDataCapability node. More...
 
virtual OpcUa::PropertyTypegetUpdateEventCapabilityNode ()
 Returns the UpdateEventCapability node. More...
 
virtual const OpcUa::PropertyTypegetUpdateEventCapabilityNode () const
 Returns the UpdateEventCapability node. More...
 
virtual void useAccessInfoFromType ()
 Applies the NodeAccessInfo set at the HistoryServerCapabilitiesType and its children. More...
 
void useAccessInfoFromInstance (HistoryServerCapabilitiesType *pInstance)
 Uses the NodeAccessInfo of pOther and its children. More...
 
- Public Member Functions inherited from OpcUa::BaseObjectType
 BaseObjectType (const UaNodeId &nodeId, UaObject *pInstanceDeclarationObject, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
 BaseObjectType (const UaNodeId &nodeId, const UaString &name, OpcUa_UInt16 browseNameNameSpaceIndex, NodeManagerConfig *pNodeConfig, UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the class BaseObjectType. More...
 
UaReferenceListsgetUaReferenceLists () const
 Get the UaReferenceLists interface for the node. More...
 
virtual UaStatus browse (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
UaNodeId nodeId () const
 Get the NodeId of the current Node. More...
 
virtual UaQualifiedName browseName () const
 Get the browseName of the current Node. More...
 
virtual UaLocalizedText displayName (Session *pSession) const
 Get the displayName as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isDescriptionSupported () const
 Check if Node is DescriptionSupported. More...
 
virtual UaLocalizedText description (Session *pSession) const
 Get the description as LocalizedText of the current Node. More...
 
virtual OpcUa_Boolean isWriteMaskSupported () const
 Check if Node is WriteMaskSupported. More...
 
virtual OpcUa_UInt32 writeMask () const
 Get the writeMask of the current Node. More...
 
virtual OpcUa_Boolean isUserWriteMaskSupported () const
 Check if Node is UserWriteMaskSupported. More...
 
virtual OpcUa_UInt32 userWriteMask (Session *pSession) const
 Check if Node has a userWriteMask. More...
 
UaNodegetUaNode () const
 Get the UaNode interface pointer of this node. More...
 
virtual OpcUa_Byte eventNotifier () const
 Returns the EventNotifier for the BaseObjectType. More...
 
virtual MethodManagergetMethodManager (UaMethod *pMethod) const
 Returns the method manager interface for the BaseObjectType instance. More...
 
virtual void setUserData (UserDataBase *pUserData)
 Method to set user data stored in this class. More...
 
virtual UserDataBasegetUserData () const
 Method to get the user data stored in this class. More...
 
virtual void setBrowseName (const UaQualifiedName &browseName)
 Sets the browse name attribute value. More...
 
virtual void setDisplayName (const UaLocalizedText &displayName)
 Sets the display name attribute value. More...
 
virtual void setDescription (const UaLocalizedText &description)
 Sets the description attribute value. More...
 
virtual void setWriteMask (OpcUa_UInt32 writeMask)
 Sets the write mask attribute value. More...
 
virtual void setEventNotifier (OpcUa_Byte eventNotifier)
 Sets the eventNotifier attribute value. More...
 
virtual void setModellingRuleId (const UaNodeId &modellingRuleId)
 Set NodeId of the modeling rule for this node. More...
 
virtual UaNodeId modellingRuleId () const
 Get NodeId of the modeling rule for this node. More...
 
void setMethodManager (MethodManager *pMethodManager)
 Allows a class aggregating the object to implement the MethodManager for this object. More...
 
virtual UaStatus setAttributeValue (Session *pSession, OpcUa_Int32 attributeId, const UaDataValue &dataValue, NodeAccessInfo *pDefaultPermissions, OpcUa_Boolean checkWriteMask)
 Sets the value of an attribute of the Node. More...
 
virtual UaStatus beginCall (MethodManagerCallback *pCallback, const ServiceContext &serviceContext, OpcUa_UInt32 callbackHandle, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments)
 Implementation of the MethodManager interface method beginCall.
 
virtual UaStatus call (const ServiceContext &serviceContext, MethodHandle *pMethodHandle, const UaVariantArray &inputArguments, UaVariantArray &outputArguments, UaStatusCodeArray &inputArgumentResults, UaDiagnosticInfos &inputArgumentDiag)
 Synchronous version of the MethodManager method call executed in a worker thread.
 
- Public Member Functions inherited from MethodManager
 MethodManager ()
 construction
 
virtual ~MethodManager ()
 destruction
 
- Public Member Functions inherited from UaObject
 UaObject (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaObject. More...
 
OpcUa_NodeClass nodeClass () const
 Get the node class of the Node. More...
 
virtual void getAttributeValue (Session *pSession, OpcUa_Int32 attributeId, NodeAccessInfo *pDefaultPermissions, UaDataValue &uaDataValue)
 Gets the value of an attribute of the Node. More...
 
- Public Member Functions inherited from UaNode
 UaNode (UaMutexRefCounted *pSharedMutex=NULL)
 Construction of the UaNode. More...
 
virtual UaNodeId getKey () const
 Get the key of the node used for the hash table. More...
 
virtual NodeAccessInfogetAccessInfo () const
 Returns the access info for this node. More...
 
virtual bool hasAccessInfo () const
 Check if this UaNode has a NodeAccessInfo assigned. More...
 
virtual void useAccessInfoFrom (const UaNode *pOther)
 Set the NodeAccessInfo from another node to this node. More...
 
virtual void setAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
virtual void attachAccessInfo (NodeAccessInfo *pAccessInfo)
 Set the NodeAccessInfo for this node. More...
 
- Public Member Functions inherited from ChainEntry
 ChainEntry ()
 construction
 
ChainEntryfind (const UaNodeId &key, ChainEntry **ppPrevious)
 finds the right entry in the chain. More...
 
void add (ChainEntry *pNewEntry)
 adds a new entry to the list. More...
 
void prepend (ChainEntry *pNewEntry)
 prepends a new entry to the list. More...
 
ChainEntryremove (const UaNodeId &key, ChainEntry **ppNext)
 removes an entry from the list. More...
 
ChainEntrygetNext () const
 Check if there is a chain. More...
 
virtual void setInvalid ()
 Set the entry to invalid. More...
 
void clearChain ()
 Clear the chain when the hashtable is cleared.
 
- Public Member Functions inherited from ReferenceCounter
 ReferenceCounter ()
 construction
 
virtual ~ReferenceCounter ()
 destruction
 
- Public Member Functions inherited from UaReferenceLists
 UaReferenceLists ()
 Constructs the reference lists object.
 
virtual ~UaReferenceLists ()
 Destroys the reference lists object.
 
virtual UaStatus browseReferences (const ServiceContext &serviceContext, BrowseContext &browseContext, UaReferenceDescriptions &References)
 Discover the references of a specified node of a view. More...
 
virtual UaStatus translateBrowsePathToNodeId (const ServiceContext &serviceContext, const UaNodeId &startingNode, UaRelativePath &relativePath, UaBrowsePathTargets &browsePathTargets)
 Find a node based on an element of an relative path. More...
 
virtual const UaReferencepTargetNodes () const
 Returns the list of references to target nodes. More...
 
virtual const UaReferencepSourceNodes () const
 Returns the list of references to source nodes. More...
 
virtual UaNodegetTargetNodeByBrowseName (const UaQualifiedName &browseName) const
 Searches a target node with the passed browse name and returns the UaNode interface if found. More...
 
virtual void addTargetNode (UaReference *pReference)
 Add a reference to a target node where this node is the source node. More...
 
virtual void addSourceNode (UaReference *pReference)
 Adds a reference to a source node where this node is the target node. More...
 
virtual UaStatus removeSourceNode (UaReference *pReferenceToRemove)
 Remove a reference to a source node where this node is the target node. More...
 
virtual bool removeSourceReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a source node. More...
 
virtual UaStatus removeTargetNode (UaNode *pTargetNode, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual UaStatus removeTargetNode (const UaNodeId &targetNodeId, const UaNodeId &referenceTypeId, OpcUa_Boolean deleteBidirectional)
 Remove a reference to a target node where this node is the source node. More...
 
virtual bool removeTargetReference (UaReference *pReferenceToRemove)
 Remove the passed reference to a target node. More...
 
virtual UaStatus removeCrossNodeManagerRef (NodeManager *pNodeManager)
 Remove references to another NodeManager. More...
 
virtual UaStatus invalidateSourceReferences (OpcUa_Boolean deleteSourceReferences)
 Set all references from SourceNodes to this Node invalid. More...
 
virtual UaStatus invalidateTargetReferences (OpcUa_Boolean deleteTargetReferences)
 Set all references to TargetNode of this node invalid. More...
 
virtual UaStatus deleteAllChildren (NodeManagerConfig *pNodeManagerConfig)
 Deletes all child nodes. More...
 

Static Public Member Functions

static void createTypes ()
 Create the related type nodes.
 
static void clearStaticMembers ()
 Clear the static members of the class.
 
- Static Public Member Functions inherited from OpcUa::BaseObjectType
static void clearStaticMembers ()
 Clear the static members of the class.
 

Protected Member Functions

virtual ~HistoryServerCapabilitiesType ()
 Destruction.
 
- Protected Member Functions inherited from OpcUa::BaseObjectType
virtual ~BaseObjectType ()
 Destruction of the BaseObjectType. More...
 
- Protected Member Functions inherited from UaObject
virtual ~UaObject ()
 Destruction of the UaObject. More...
 
- Protected Member Functions inherited from UaNode
virtual ~UaNode ()
 Destruction of the UaNode. More...
 
- Protected Member Functions inherited from ChainEntry
virtual ~ChainEntry ()
 destruction
 
- Protected Member Functions inherited from UaReferenceLists
virtual UaStatus collectAllChildrenRecursive (NodeManagerConfig *pNodeManagerConfig, NodesToDeleteCollection &nodesToDeleteCollection, int recursionCounter=0)
 Collect a list of all child nodes. More...
 

Additional Inherited Members

- Protected Attributes inherited from UaReferenceLists
UaReferencem_pTargetNodes
 List of references to target nodes where this node is the source node. More...
 
UaReferencem_pLastTargetNode
 Last references in the list of references to the target nodes. More...
 
UaReferencem_pSourceNodes
 List of references to source nodes where this node is the target node. More...
 

Detailed Description

Class implementing the UaObject interface for the HistoryServerCapabilitiesType.

OPC UA Objects are used to represent systems, system components, real-world objects and software objects. They have the NodeClass Object. The detailed description of Objects and their attributes can be found in the general description of the Object node class.

Object members of the HistoryServerCapabilitiesType:

Browse Name TypeDefinition Modelling Rule See Also
AggregateFunctions FolderType Mandatory  

Variable members of the HistoryServerCapabilitiesType:

Browse Name DataType TypeDefinition Modelling Rule See Also
AccessHistoryDataCapability Boolean PropertyType Mandatory getAccessHistoryDataCapability, setAccessHistoryDataCapability
AccessHistoryEventsCapability Boolean PropertyType Mandatory getAccessHistoryEventsCapability, setAccessHistoryEventsCapability
DeleteAtTimeCapability Boolean PropertyType Mandatory getDeleteAtTimeCapability, setDeleteAtTimeCapability
DeleteEventCapability Boolean PropertyType Mandatory getDeleteEventCapability, setDeleteEventCapability
DeleteRawCapability Boolean PropertyType Mandatory getDeleteRawCapability, setDeleteRawCapability
InsertAnnotationCapability Boolean PropertyType Mandatory getInsertAnnotationCapability, setInsertAnnotationCapability
InsertDataCapability Boolean PropertyType Mandatory getInsertDataCapability, setInsertDataCapability
InsertEventCapability Boolean PropertyType Mandatory getInsertEventCapability, setInsertEventCapability
MaxReturnDataValues UInt32 PropertyType Mandatory getMaxReturnDataValues, setMaxReturnDataValues
MaxReturnEventValues UInt32 PropertyType Mandatory getMaxReturnEventValues, setMaxReturnEventValues
ReplaceDataCapability Boolean PropertyType Mandatory getReplaceDataCapability, setReplaceDataCapability
ReplaceEventCapability Boolean PropertyType Mandatory getReplaceEventCapability, setReplaceEventCapability
ServerTimestampSupported Boolean PropertyType Mandatory getServerTimestampSupported, setServerTimestampSupported
UpdateDataCapability Boolean PropertyType Mandatory getUpdateDataCapability, setUpdateDataCapability
UpdateEventCapability Boolean PropertyType Mandatory getUpdateEventCapability, setUpdateEventCapability

The ServerCapabilitiesType Objects for any OPC UA Server supporting Historical Access shall contain a Reference to a HistoryServerCapabilitiesType Object.

The content of this BaseObjectType is already defined by its type definition in Part 5 of the OPC UA Specification.

The object extensions are intended to inform a Client of the general capabilities of the server. They do not guarantee that all capabilities will be available for all Nodes. For example, not all Nodes will support Events, or in the case of an aggregating server where underlying servers may not support Insert or a particular Aggregate. In such cases, the HistoryServerCapabilities Property would indicate the capability is supported, and the server would return appropriate StatusCodes for situations where the capability does not apply.

All UA servers that support Historical access shall include the HistoryServerCapabilities as part of its ServerCapabilities.

See also HistoryServerCapabilitiesType for a documentation of the complete Information Model.

Constructor & Destructor Documentation

OpcUa::HistoryServerCapabilitiesType::HistoryServerCapabilitiesType ( const UaNodeId nodeId,
UaObject pInstanceDeclarationObject,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class HistoryServerCapabilitiesType.

This constructor is used if the object is created based on an instance declaration of an object type. Since the only difference between the instance declaration object and the instance object are the node id, the pointer to the instance declaration node is used to get the attribute values other than NodeId from the instance declaration node.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]pInstanceDeclarationObjectUaObject interface of the instance declaration node used to provide attribute values other than NodeId
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided
OpcUa::HistoryServerCapabilitiesType::HistoryServerCapabilitiesType ( const UaNodeId nodeId,
const UaString name,
OpcUa_UInt16  browseNameNameSpaceIndex,
NodeManagerConfig pNodeConfig,
UaMutexRefCounted pSharedMutex = NULL 
)

Construction of the class HistoryServerCapabilitiesType.

This constructor is used if the object is not created based on an instance declaration. It defines the name and node id of the object. Additional language specific names and other attribute values can be set with set methods provided by the class.

The object is reference counted and can not be deleted directly. The reference counter is set to one after the object is created. If the object was successfully added to a NodeManager using the methods NodeManagerConfig::addUaNode or NodeManagerConfig::addNodeAndReference the NodeManager will release this reference during shut down. If the object was not added to a NodeManager, it must be deleted using the releaseReference method. If the interface pointer is used in other places, the availability of the object must be ensured by incrementing the reference counter with addReference when the pointer is stored somewhere and decremented with releaseReference if the interface pointer is not longer needed.

Parameters
[in]nodeIdNodeId of the new object
[in]nameName of the new object. Used as browse name and also as display name if no additional language specific names are set.
[in]browseNameNameSpaceIndexNamespace index used for the browse name
[in]pNodeConfigInterface pointer to the NodeManagerConfig interface used to add and delete node and references in the address space
[in]pSharedMutexShared mutex object used to synchronize access to the object. Can be NULL if no shared mutex is provided

Member Function Documentation

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getAccessHistoryDataCapability ( ) const
virtual

Returns the value of AccessHistoryDataCapability.

Defines if the server supports access to historical data values.

A value of True indicates the server supports access to history for HistoricalNodes, a value of False indicates the server does not support access to history for HistoricalNodes. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getAccessHistoryDataCapabilityNode ( )
virtual

Returns the AccessHistoryDataCapability node.

Defines if the server supports access to historical data values.

A value of True indicates the server supports access to history for HistoricalNodes, a value of False indicates the server does not support access to history for HistoricalNodes. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getAccessHistoryDataCapabilityNode ( ) const
virtual

Returns the AccessHistoryDataCapability node.

Defines if the server supports access to historical data values.

A value of True indicates the server supports access to history for HistoricalNodes, a value of False indicates the server does not support access to history for HistoricalNodes. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getAccessHistoryEventsCapability ( ) const
virtual

Returns the value of AccessHistoryEventsCapability.

Defines if the server supports access to historical Events.

A value of True indicates the server supports access to history of Events, a value of False indicates the server does not support access to history of Events. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getAccessHistoryEventsCapabilityNode ( )
virtual

Returns the AccessHistoryEventsCapability node.

Defines if the server supports access to historical Events.

A value of True indicates the server supports access to history of Events, a value of False indicates the server does not support access to history of Events. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getAccessHistoryEventsCapabilityNode ( ) const
virtual

Returns the AccessHistoryEventsCapability node.

Defines if the server supports access to historical Events.

A value of True indicates the server supports access to history of Events, a value of False indicates the server does not support access to history of Events. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

OpcUa::FolderType * OpcUa::HistoryServerCapabilitiesType::getAggregateFunctions ( )
virtual

Returns the AggregateFunctions node.

An entry point to browse to all Aggregate capabilities supported by the server for Historical Access.

All HistoryAggregates supported by the Server should be able to be browsed starting from this object. Aggregates are defined in Part 13 of the OPC UA Specification. If the Server does not support Aggregates the Folder is left empty.

const OpcUa::FolderType * OpcUa::HistoryServerCapabilitiesType::getAggregateFunctions ( ) const
virtual

Returns the AggregateFunctions node.

An entry point to browse to all Aggregate capabilities supported by the server for Historical Access.

All HistoryAggregates supported by the Server should be able to be browsed starting from this object. Aggregates are defined in Part 13 of the OPC UA Specification. If the Server does not support Aggregates the Folder is left empty.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getDeleteAtTimeCapability ( ) const
virtual

Returns the value of DeleteAtTimeCapability.

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getDeleteAtTimeCapabilityNode ( )
virtual

Returns the DeleteAtTimeCapability node.

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getDeleteAtTimeCapabilityNode ( ) const
virtual

Returns the DeleteAtTimeCapability node.

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getDeleteEventCapability ( ) const
virtual

Returns the value of DeleteEventCapability.

Indicates support for the deletion of Events capability.

A value of True indicates the server supports the capability to delete Events in history. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getDeleteEventCapabilityNode ( )
virtual

Returns the DeleteEventCapability node.

Indicates support for the deletion of Events capability.

A value of True indicates the server supports the capability to delete Events in history. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getDeleteEventCapabilityNode ( ) const
virtual

Returns the DeleteEventCapability node.

Indicates support for the deletion of Events capability.

A value of True indicates the server supports the capability to delete Events in history. The default value is False.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getDeleteRawCapability ( ) const
virtual

Returns the value of DeleteRawCapability.

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getDeleteRawCapabilityNode ( )
virtual

Returns the DeleteRawCapability node.

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getDeleteRawCapabilityNode ( ) const
virtual

Returns the DeleteRawCapability node.

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getInsertAnnotationCapability ( ) const
virtual

Returns the value of InsertAnnotationCapability.

Indicates support for Annotations.

A value of True indicates the server supports the capability to insert Annotations. Some Servers that support Inserting of Annotations will also support editing and deleting of Annotations. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getInsertAnnotationCapabilityNode ( )
virtual

Returns the InsertAnnotationCapability node.

Indicates support for Annotations.

A value of True indicates the server supports the capability to insert Annotations. Some Servers that support Inserting of Annotations will also support editing and deleting of Annotations. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getInsertAnnotationCapabilityNode ( ) const
virtual

Returns the InsertAnnotationCapability node.

Indicates support for Annotations.

A value of True indicates the server supports the capability to insert Annotations. Some Servers that support Inserting of Annotations will also support editing and deleting of Annotations. The default value is False.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getInsertDataCapability ( ) const
virtual

Returns the value of InsertDataCapability.

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new data values in history, but not overwrite existing values. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getInsertDataCapabilityNode ( )
virtual

Returns the InsertDataCapability node.

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new data values in history, but not overwrite existing values. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getInsertDataCapabilityNode ( ) const
virtual

Returns the InsertDataCapability node.

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new data values in history, but not overwrite existing values. The default value is False.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getInsertEventCapability ( ) const
virtual

Returns the value of InsertEventCapability.

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new Events in history. An insert is not a replace. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getInsertEventCapabilityNode ( )
virtual

Returns the InsertEventCapability node.

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new Events in history. An insert is not a replace. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getInsertEventCapabilityNode ( ) const
virtual

Returns the InsertEventCapability node.

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new Events in history. An insert is not a replace. The default value is False.

OpcUa_UInt32 OpcUa::HistoryServerCapabilitiesType::getMaxReturnDataValues ( ) const
virtual

Returns the value of MaxReturnDataValues.

Defines maximum number of values that can be returned by the server for each HistoricalNode accessed during a request.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getMaxReturnDataValuesNode ( )
virtual

Returns the MaxReturnDataValues node.

Defines maximum number of values that can be returned by the server for each HistoricalNode accessed during a request.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getMaxReturnDataValuesNode ( ) const
virtual

Returns the MaxReturnDataValues node.

Defines maximum number of values that can be returned by the server for each HistoricalNode accessed during a request.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

OpcUa_UInt32 OpcUa::HistoryServerCapabilitiesType::getMaxReturnEventValues ( ) const
virtual

Returns the value of MaxReturnEventValues.

Specifies the maximum number of Events that a server can return for a HistoricalEventNode.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getMaxReturnEventValuesNode ( )
virtual

Returns the MaxReturnEventValues node.

Specifies the maximum number of Events that a server can return for a HistoricalEventNode.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getMaxReturnEventValuesNode ( ) const
virtual

Returns the MaxReturnEventValues node.

Specifies the maximum number of Events that a server can return for a HistoricalEventNode.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getReplaceDataCapability ( ) const
virtual

Returns the value of ReplaceDataCapability.

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing data values in history, but will not insert new values. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getReplaceDataCapabilityNode ( )
virtual

Returns the ReplaceDataCapability node.

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing data values in history, but will not insert new values. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getReplaceDataCapabilityNode ( ) const
virtual

Returns the ReplaceDataCapability node.

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing data values in history, but will not insert new values. The default value is False.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getReplaceEventCapability ( ) const
virtual

Returns the value of ReplaceEventCapability.

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing Events in history. A replace is not an insert. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getReplaceEventCapabilityNode ( )
virtual

Returns the ReplaceEventCapability node.

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing Events in history. A replace is not an insert. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getReplaceEventCapabilityNode ( ) const
virtual

Returns the ReplaceEventCapability node.

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing Events in history. A replace is not an insert. The default value is False.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getUpdateDataCapability ( ) const
virtual

Returns the value of UpdateDataCapability.

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new data values into history if none exists, and replace values that currently exist. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getUpdateDataCapabilityNode ( )
virtual

Returns the UpdateDataCapability node.

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new data values into history if none exists, and replace values that currently exist. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getUpdateDataCapabilityNode ( ) const
virtual

Returns the UpdateDataCapability node.

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new data values into history if none exists, and replace values that currently exist. The default value is False.

OpcUa_Boolean OpcUa::HistoryServerCapabilitiesType::getUpdateEventCapability ( ) const
virtual

Returns the value of UpdateEventCapability.

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new Events into history if none exists, and replace values that currently exist. The default value is False.

OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getUpdateEventCapabilityNode ( )
virtual

Returns the UpdateEventCapability node.

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new Events into history if none exists, and replace values that currently exist. The default value is False.

const OpcUa::PropertyType * OpcUa::HistoryServerCapabilitiesType::getUpdateEventCapabilityNode ( ) const
virtual

Returns the UpdateEventCapability node.

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new Events into history if none exists, and replace values that currently exist. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setAccessHistoryDataCapability ( OpcUa_Boolean  AccessHistoryDataCapability)
virtual

Sets the AccessHistoryDataCapability value.

Defines if the server supports access to historical data values.

A value of True indicates the server supports access to history for HistoricalNodes, a value of False indicates the server does not support access to history for HistoricalNodes. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

void OpcUa::HistoryServerCapabilitiesType::setAccessHistoryEventsCapability ( OpcUa_Boolean  AccessHistoryEventsCapability)
virtual

Sets the AccessHistoryEventsCapability value.

Defines if the server supports access to historical Events.

A value of True indicates the server supports access to history of Events, a value of False indicates the server does not support access to history of Events. The default value is False. At least one of AccessHistoryDataCapability or AccessHistoryEventsCapability shall have a value of True for the server to be a valid OPC UA Server supporting Historical Access.

void OpcUa::HistoryServerCapabilitiesType::setDeleteAtTimeCapability ( OpcUa_Boolean  DeleteAtTimeCapability)
virtual

Sets the DeleteAtTimeCapability value.

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setDeleteEventCapability ( OpcUa_Boolean  DeleteEventCapability)
virtual

Sets the DeleteEventCapability value.

Indicates support for the deletion of Events capability.

A value of True indicates the server supports the capability to delete Events in history. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setDeleteRawCapability ( OpcUa_Boolean  DeleteRawCapability)
virtual

Sets the DeleteRawCapability value.

Indicates support for the delete raw values capability.

A value of True indicates the server supports the capability to delete raw data values in history. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setInsertAnnotationCapability ( OpcUa_Boolean  InsertAnnotationCapability)
virtual

Sets the InsertAnnotationCapability value.

Indicates support for Annotations.

A value of True indicates the server supports the capability to insert Annotations. Some Servers that support Inserting of Annotations will also support editing and deleting of Annotations. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setInsertDataCapability ( OpcUa_Boolean  InsertDataCapability)
virtual

Sets the InsertDataCapability value.

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new data values in history, but not overwrite existing values. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setInsertEventCapability ( OpcUa_Boolean  InsertEventCapability)
virtual

Sets the InsertEventCapability value.

Indicates support for the Insert capability.

A value of True indicates the server supports the capability to insert new Events in history. An insert is not a replace. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setMaxReturnDataValues ( OpcUa_UInt32  MaxReturnDataValues)
virtual

Sets the MaxReturnDataValues value.

Defines maximum number of values that can be returned by the server for each HistoricalNode accessed during a request.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

void OpcUa::HistoryServerCapabilitiesType::setMaxReturnEventValues ( OpcUa_UInt32  MaxReturnEventValues)
virtual

Sets the MaxReturnEventValues value.

Specifies the maximum number of Events that a server can return for a HistoricalEventNode.

A value of 0 indicates that the server forces no limit on the number of values it can return. It is valid for a server to limit the number of returned values and return a continuation point even if MaxReturnValues = 0. For example, it is possible that although the server does not impose any restrictions, the underlying system may impose a limit that the server is not aware of. The default value is 0.

void OpcUa::HistoryServerCapabilitiesType::setReplaceDataCapability ( OpcUa_Boolean  ReplaceDataCapability)
virtual

Sets the ReplaceDataCapability value.

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing data values in history, but will not insert new values. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setReplaceEventCapability ( OpcUa_Boolean  ReplaceEventCapability)
virtual

Sets the ReplaceEventCapability value.

Indicates support for the Replace capability.

A value of True indicates the server supports the capability to replace existing Events in history. A replace is not an insert. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setUpdateDataCapability ( OpcUa_Boolean  UpdateDataCapability)
virtual

Sets the UpdateDataCapability value.

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new data values into history if none exists, and replace values that currently exist. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::setUpdateEventCapability ( OpcUa_Boolean  UpdateEventCapability)
virtual

Sets the UpdateEventCapability value.

Indicates support for the Update capability.

A value of True indicates the server supports the capability to insert new Events into history if none exists, and replace values that currently exist. The default value is False.

void OpcUa::HistoryServerCapabilitiesType::useAccessInfoFromInstance ( HistoryServerCapabilitiesType pOther)

Uses the NodeAccessInfo of pOther and its children.

void OpcUa::HistoryServerCapabilitiesType::useAccessInfoFromType ( )
virtual

Applies the NodeAccessInfo set at the HistoryServerCapabilitiesType and its children.

Reimplemented from OpcUa::BaseObjectType.


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