protocol/view.h

Go to the documentation of this file.

#ifndef __OPC_UA_BINARY_VIEW_H__
#define __OPC_UA_BINARY_VIEW_H__

#include <opc/ua/protocol/types.h>

namespace OpcUa
{

//---------------------------------------------------
// Browse
//---------------------------------------------------



struct ViewDescription
{
  NodeId Id;
  DateTime Timestamp;
  uint32_t Version;

  ViewDescription();
};

struct BrowseDescription
{
  NodeId NodeToBrowse;
  BrowseDirection Direction;
  NodeId ReferenceTypeId;
  bool IncludeSubtypes; // If false will follow strctly ReferenceTypeId. if true will follow subtypes of ReferenceTypeId.
  NodeClass NodeClasses;
  BrowseResultMask ResultMask;

  BrowseDescription();
};

struct NodesQuery
{
  ViewDescription View;
  uint32_t MaxReferenciesPerNode;
  std::vector<BrowseDescription> NodesToBrowse;

  NodesQuery();
};

struct BrowseRequest
{
  NodeId TypeId;
  RequestHeader Header;
  NodesQuery Query;

  BrowseRequest();
};


struct ReferenceDescription
{
  NodeId ReferenceTypeId;
  bool IsForward = true;
  NodeId TargetNodeId;
  QualifiedName BrowseName;
  LocalizedText DisplayName;
  NodeClass TargetNodeClass;
  NodeId TargetNodeTypeDefinition;

  ReferenceDescription();
};

struct BrowseResult
{
  StatusCode Status;
  std::vector<uint8_t> ContinuationPoint;
  std::vector<ReferenceDescription> Referencies;

  BrowseResult();
};

struct BrowseResponse
{
  NodeId TypeId;
  ResponseHeader Header;

  std::vector<BrowseResult> Results;
  DiagnosticInfoList Diagnostics;

  BrowseResponse();
};

//---------------------------------------------------
// BrowseNext
//---------------------------------------------------

struct BrowseNextRequest
{
  NodeId TypeId;
  RequestHeader Header;

  bool ReleaseContinuationPoints;
  std::vector<std::vector<uint8_t>> ContinuationPoints;

  BrowseNextRequest();
};

struct BrowseNextResponse
{
  NodeId TypeId;
  ResponseHeader Header;

  std::vector<BrowseResult> Results;
  DiagnosticInfoList Diagnostics;

  BrowseNextResponse();
};

//---------------------------------------------------
// TranslateBrowsePathsToNodeIds
//---------------------------------------------------

struct BrowsePath
{
  NodeId StartingNode;
  RelativePath Path;
};

struct TranslateBrowsePathsParameters
{
  std::vector<BrowsePath> BrowsePaths;
};

struct TranslateBrowsePathsToNodeIdsRequest
{
  NodeId TypeId;
  RequestHeader Header;
  TranslateBrowsePathsParameters Parameters;

  TranslateBrowsePathsToNodeIdsRequest();
};

//---------------------------------------------------
// TranslateBrowsePathsToNodeIds
//---------------------------------------------------

struct BrowsePathTarget
{
  NodeId Node;
  uint32_t RemainingPathIndex;

  BrowsePathTarget();
};

struct BrowsePathResult
{
  StatusCode Status;
  std::vector<BrowsePathTarget> Targets;

  BrowsePathResult();
};

struct TranslateBrowsePathsResult
{
  std::vector<BrowsePathResult> Paths;
  DiagnosticInfoList Diagnostics;
};

struct TranslateBrowsePathsToNodeIdsResponse
{
  NodeId TypeId;
  ResponseHeader Header;
  TranslateBrowsePathsResult Result;

  TranslateBrowsePathsToNodeIdsResponse();
};

struct RegisterNodesRequest
{
  OpcUa::NodeId TypeId;
  OpcUa::RequestHeader Header;
  std::vector<OpcUa::NodeId> NodesToRegister;

  RegisterNodesRequest();
};

struct RegisterNodesResponse
{
  OpcUa::NodeId TypeId;
  OpcUa::ResponseHeader Header;
  std::vector<OpcUa::NodeId> Result;

  RegisterNodesResponse();
};

struct UnregisterNodesRequest
{
  OpcUa::NodeId TypeId;
  OpcUa::RequestHeader Header;
  std::vector<OpcUa::NodeId> NodesToUnregister;

  UnregisterNodesRequest();
};

struct UnregisterNodesResponse
{
  OpcUa::NodeId TypeId;
  OpcUa::ResponseHeader Header;

  UnregisterNodesResponse();
};

} // namespace OpcUa

#endif // __OPC_UA_BINARY_VIEW_H__