UaSimpleAttributeOperand Class Reference
#include <uacontentfilter.h>
Public Member Functions | |
| UaSimpleAttributeOperand () | |
| virtual | ~UaSimpleAttributeOperand () |
| UaFilterOperand::FilterOperandType | getFilterOperandType () const |
| void | getSimpleAttributeOperand (OpcUa_SimpleAttributeOperand &operand, OpcUa_Boolean createDeepCopy) const |
| void | setTypeId (const UaNodeId &typeId) |
| UaNodeId | typeId () const |
| void | setBrowsePathElement (OpcUa_UInt32 index, const UaQualifiedName &name, OpcUa_UInt32 arraySize) |
| void | clearBrowsePath () |
| const OpcUa_QualifiedName * | browsePath () const |
| void | setAttributeId (OpcUa_UInt32 attributeId) |
| OpcUa_UInt32 | attributeId () const |
| void | setIndexRange (const UaString &indexRange) |
| UaString | indexRange () const |
| UaString | toString () const |
Detailed Description
OPC UA SimpleAttributeOperand used in ContentFilterElement or UaEventFilter.
This class is used to build and hold an OPC UA SimpleAttributeOperand used in the UaContentFilterElement or in the UaEventFilter. The selectClause and whereClause parameters of an EventFilter are specified with the SimpleAttributeOperand structure. The structure is composed of
- typeId (NodeId) NodeId of the type definition node. This is an event type node for event filters. In some cases the same BrowsePath will apply to multiple EventTypes. If the Client specifies the BaseEventType in the SimpleAttributeOperand then the Server shall evaluate the BrowsePath without considering the Type. The default value for the typeId set by the class is the BaseEventType.
- browsePath[] (QualifiedName) This parameter specifies a relative path using a list of BrowseNames. The list of BrowseNames in an event fileter represents the nodes from an EventType to the event field of interest following hirarchical forward references. All Nodes followed by the browsePath shall be of the NodeClass Object or Variable. If this list is empty the Node is the instance of the TypeDefinition e.g. the instance of a Condition object.
- attributeId (IntegerId) The SimpleAttributeOperand structure allows the Client to specify any Attribute, however, the Server is only required to support the Value Attribute (OpcUa_Attributes_Value) for Variable Nodes and the NodeId Attribute (OpcUa_Attributes_NodeId)for Object Nodes. The default value set by this class is the Value attribute.
- indexRange (NumericRange) This parameter is used to identify a single element of an array, or a single range of indexes for an array.
This class is concrete implementation of the abstract UaFilterOperand. It specifies any attribute of an object or variable node using a TypeDefinition and a relative path constructed from BrowseNames.
Constructor & Destructor Documentation
| UaSimpleAttributeOperand::UaSimpleAttributeOperand | ( | ) |
Constructs an empty simple attribute filter operand object with the attribute set to Value.
| UaSimpleAttributeOperand::~UaSimpleAttributeOperand | ( | ) | [virtual] |
Destroys the simple attribute filter operand object
Member Function Documentation
| OpcUa_UInt32 UaSimpleAttributeOperand::attributeId | ( | ) | const |
Returns the AttributeId of the simple attribute operand.
| const OpcUa_QualifiedName * UaSimpleAttributeOperand::browsePath | ( | ) | const |
Returns the BrowsePath of the attribute operand.
- Returns:
- Pointer to the raw OpcUa_QualifiedName name array building the BrowsPath.
| void UaSimpleAttributeOperand::clearBrowsePath | ( | ) |
Cleares the browse path.
| UaFilterOperand::FilterOperandType UaSimpleAttributeOperand::getFilterOperandType | ( | ) | const [virtual] |
Returns the filter operand type SimpleAttribute.
Implements UaFilterOperand.
| void UaSimpleAttributeOperand::getSimpleAttributeOperand | ( | OpcUa_SimpleAttributeOperand & | operand, |
| OpcUa_Boolean | createDeepCopy | ||
| ) | const |
Returns the SimpleAttributeOperand contained in the OpcUa_SimpleAttributeOperand.
- Parameters:
-
[in] operand SimpleAttributeOperand structure to be filled [in] createDeepCopy Flag indicating the type of copy, TRUE creates a deep copy and the caller must free the memory, FALS creates a shallow copy and the caller must not clear the memory
| UaString UaSimpleAttributeOperand::indexRange | ( | ) | const |
Returns the IndexRange of the simple attribute operand.
| void UaSimpleAttributeOperand::setAttributeId | ( | OpcUa_UInt32 | attributeId ) |
Sets the AttributeId of the simple attribute operand.
- Parameters:
-
attributeId The Id to set
| void UaSimpleAttributeOperand::setBrowsePathElement | ( | OpcUa_UInt32 | index, |
| const UaQualifiedName & | name, | ||
| OpcUa_UInt32 | arraySize | ||
| ) |
Sets one element of the browse path. The browse path is composed of an array of QualifiedNames.
- Parameters:
-
[in] index Index of the browse path elmenet in the array [in] name QualifiedName to set at the index in the array [in] arraySize Size of the name array filled with this method
| void UaSimpleAttributeOperand::setIndexRange | ( | const UaString & | indexRange ) |
Sets the IndexRange of the simple attribute operand.
- Parameters:
-
[in] indexRange the IndexRange of the simple attribute operand.
| void UaSimpleAttributeOperand::setTypeId | ( | const UaNodeId & | typeId ) |
Sets the type nodeId for the attribute operand.
- Parameters:
-
[in] typeId The nodeId for the attribute operand.
| UaString UaSimpleAttributeOperand::toString | ( | ) | const |
Returns the simple attribute operand as string.
| UaNodeId UaSimpleAttributeOperand::typeId | ( | ) | const |
Returns the type nodeId of the attribute operand.
The documentation for this class was generated from the following files:
- /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uacontentfilter.h
- /home/buildbot/work/uasdkcpp/src/uabase/uabasecpp/uacontentfilter.cpp
