node_management.h

Go to the documentation of this file.

#ifndef __OPC_UA_BINARY_NODEMANAGEMENT_H_
#define __OPC_UA_BINARY_NODEMANAGEMENT_H_

#include <opc/ua/protocol/attribute_ids.h>
#include <opc/ua/protocol/data_value.h>
#include <opc/ua/protocol/types.h>
#include <opc/ua/protocol/variant.h>
#include <opc/ua/protocol/strings.h>
#include <opc/ua/protocol/variable_access_level.h>
#include <map>
#include <bitset>

namespace OpcUa
{

  //
  // AddNode Message definition
  //
  
  enum SpecifiedAttributesEncoding : uint32_t
  {
    AccessLevel = 0,
    ArrayDimensions = 1,
    ContainsNoLoops = 3,
    DataType = 4,
    Description = 5,
    DisplayName = 6,
    EventNotifier = 7,
    Executable = 8,
    Historizing = 9,
    InverseName = 10,
    IsAbstract = 11,
    MinimumSamplingInterval = 12,
    Symmetric = 15,
    UserAccessLevel = 16,
    UserExecutable = 17,
    UserWriteMask = 18,
    ValueRank = 19,
    WriteMask = 20,
    Value = 21,
  };

  struct EventNotifier
  {
    static const uint8_t SubscribeToEvents = 1 << 0;
    static const uint8_t Reserved = 1 << 1;
    static const uint8_t HistoryRead = 1 << 2;
    static const uint8_t HistoryWrite = 1 << 3;
    //all other bytes are reserved
  };

  typedef std::bitset<sizeof(uint32_t)> IntBits;

  struct ObjectAttributes
  {
    uint32_t SpecifiedAttributes;
    LocalizedText DisplayName;
    LocalizedText Description;
    uint8_t EventNotifier = 0;
    uint32_t WriteMask = 0;
    uint32_t UserWriteMask = 0;
  };

  struct VariableAttributes
  {
    uint32_t SpecifiedAttributes;
    LocalizedText DisplayName;
    LocalizedText Description;
    Variant Value;
    NodeId Type;
    int32_t Rank = 0;
    std::vector<uint32_t> Dimensions;
    VariableAccessLevel AccessLevel = VariableAccessLevel::CurrentRead;
    VariableAccessLevel UserAccessLevel = VariableAccessLevel::CurrentRead;
    Duration MinimumSamplingInterval = 0;
    bool Historizing = false;
    uint32_t WriteMask = 0;
    uint32_t UserWriteMask = 0;
  };

  struct MethodAttributes
  {
    uint32_t SpecifiedAttributes;
    LocalizedText DisplayName;
    LocalizedText Description;
    bool Executable = false;
    bool UserExecutable = false;
    uint32_t WriteMask = 0;
    uint32_t UserWriteMask = 0;
  };

  struct ObjectTypeAttributes
  {
    uint32_t SpecifiedAttributes;
    LocalizedText DisplayName;
    LocalizedText Description;
    bool IsAbstract = false;
    uint32_t WriteMask = 0;
    uint32_t UserWriteMask = 0;
  };

  struct VariableTypeAttributes
  {
    uint32_t SpecifiedAttributes;
    LocalizedText DisplayName;
    LocalizedText Description;
    Variant Value;
    NodeId Type;
    int32_t Rank = 0;
    std::vector<uint32_t> Dimensions;
    bool IsAbstract = false;
    uint32_t WriteMask = 0;
    uint32_t UserWriteMask = 0;
  };

  struct ReferenceTypeAttributes
  {
    uint32_t SpecifiedAttributes;
    LocalizedText DisplayName;
    LocalizedText Description;
    bool IsAbstract = false;
    bool Symmetric = false;
    LocalizedText InverseName;
    uint32_t WriteMask = 0;
    uint32_t UserWriteMask = 0;
  };

  struct DataTypeAttributes
  {
    uint32_t SpecifiedAttributes;
    LocalizedText DisplayName;
    LocalizedText Description;
    bool IsAbstract = false;
    uint32_t WriteMask = 0;
    uint32_t UserWriteMask = 0;
  };

  struct ViewAttributes
  {
    uint32_t SpecifiedAttributes;
    LocalizedText DisplayName;
    LocalizedText Description;
    bool ContainsNoLoops = true;
    uint32_t WriteMask = 0;
    uint32_t UserWriteMask = 0;
  };

  struct NodeAttributes
  {
    ExtensionObjectHeader Header;
    uint32_t SpecifiedAttributes;
    std::map<AttributeId, Variant> Attributes;

    NodeAttributes(){}
    NodeAttributes(const ObjectAttributes&);
    NodeAttributes(const VariableAttributes&);
    NodeAttributes(const MethodAttributes&);
    NodeAttributes(const ObjectTypeAttributes&);
    NodeAttributes(const VariableTypeAttributes&);
    NodeAttributes(const ReferenceTypeAttributes&);
    NodeAttributes(const DataTypeAttributes&);
    NodeAttributes(const ViewAttributes&);
  };

  // TODO Rename to NodeParameters
  struct AddNodesItem
  {
    NodeId ParentNodeId;
    NodeId ReferenceTypeId;
    NodeId RequestedNewNodeId;
    QualifiedName BrowseName;
    NodeClass Class;
    NodeAttributes Attributes;
    NodeId TypeDefinition;
  };


  struct AddNodesParameters
  {
    std::vector<AddNodesItem> NodesToAdd;
  };

  struct AddNodesRequest
  {
    NodeId TypeId;
    RequestHeader Header;
    AddNodesParameters Parameters;
    AddNodesRequest();
  };

  struct AddNodesResult
  {
    StatusCode Status;
    NodeId AddedNodeId;
  };
  
  struct AddNodesResponse
  {
    NodeId TypeId;
    ResponseHeader Header;
    std::vector<AddNodesResult> results;
    DiagnosticInfoList Diagnostics;
    AddNodesResponse();
  };


  //
  // AddReference
  //

  struct AddReferencesItem
  {
    NodeId SourceNodeId;
    NodeId ReferenceTypeId;
    bool IsForward;
    std::string TargetServerUri;
    NodeId TargetNodeId;
    NodeClass TargetNodeClass;
  };

  struct AddReferencesParameters
  {
    std::vector<AddReferencesItem> ReferencesToAdd;
  };

  struct AddReferencesRequest
  {
    NodeId TypeId;
    RequestHeader Header;
    AddReferencesParameters Parameters;

    AddReferencesRequest();
  };

  struct AddReferencesResponse
  {
    NodeId TypeId;
    ResponseHeader Header;
    std::vector<StatusCode> Results;
    DiagnosticInfoList Diagnostics;

    AddReferencesResponse();
  };

  //FIXME: move somewhere else!!
  const char* GetObjectIdName(const NodeId& id) ;


}

#endif