OpenDDS::XTypes::MemberPath Class Reference

#include <Utils.h>

Public Member Functions
typedef	OPENDDS_VECTOR (DDS::MemberId) MemberIdVec
	MemberPath ()
	MemberPath (const MemberPath &other, DDS::MemberId id)
MemberPath &	id (DDS::MemberId id)
size_t	level () const
DDS::ReturnCode_t	resolve_string_path (DDS::DynamicType_ptr type, const DCPS::String &path)
DDS::ReturnCode_t	get_member_from_type (DDS::DynamicType_ptr type, DDS::DynamicTypeMember_var &member)
DDS::ReturnCode_t	get_member_from_data (DDS::DynamicData_ptr data, DDS::DynamicData_var &container, DDS::MemberId &member_id)

Public Attributes
MemberIdVec	ids

Detailed Description

Provides access to a specific member using MemberIds that may be nested inside a DynamicType or DynamicData.

Definition at line 86 of file XTypes/Utils.h.

Constructor & Destructor Documentation

MemberPath() [1/2]

OpenDDS::XTypes::MemberPath::MemberPath ( )

inline

Definition at line 91 of file XTypes/Utils.h.

  {
  }

MemberPath() [2/2]

OpenDDS::XTypes::MemberPath::MemberPath ( const MemberPath &  other, DDS::MemberId  id  )

inline

Definition at line 95 of file XTypes/Utils.h.

  : ids(other.ids)
  {
    ids.push_back(id);
  }

Member Function Documentation

get_member_from_data()

DDS::ReturnCode_t OpenDDS::XTypes::MemberPath::get_member_from_data	(	DDS::DynamicData_ptr	data,
		DDS::DynamicData_var &	container,
		DDS::MemberId &	member_id
	)

DynamicData itself holds the access methods to its members, so in order to access them, we have to give both the containing Dynamic Data and the member ID.

Definition at line 314 of file XTypes/Utils.cpp.

References ACE_ERROR, OpenDDS::XTypes::DynamicTypeMembersByIdImpl::begin(), OpenDDS::XTypes::DISCRIMINATOR_ID, OpenDDS::XTypes::DynamicTypeMembersByIdImpl::end(), OpenDDS::XTypes::Filter_All, OpenDDS::XTypes::Filter_Keys, OpenDDS::XTypes::Filter_NestedKeys, OpenDDS::XTypes::Filter_NonKeys, OpenDDS::XTypes::get_base_type(), id(), level(), LM_NOTICE, OpenDDS::DCPS::log_level, OpenDDS::DCPS::LogLevel::Notice, OpenDDS::XTypes::MemberPathParser::path, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ILLEGAL_OPERATION, DDS::RETCODE_OK, OpenDDS::XTypes::TK_STRUCTURE, OpenDDS::XTypes::TK_UNION, and OpenDDS::XTypes::typekind_to_string().

{
  container = 0;
  if (ids.empty()) {
    return DDS::RETCODE_ILLEGAL_OPERATION;
  }

  MemberIdVec::iterator it = ids.begin();
  DDS::DynamicData_var current_container = DDS::DynamicData::_duplicate(data);
  while (true) {
    const DDS::MemberId current_id = *it;
    if (++it == ids.end()) {
      member_id = current_id;
      break;
    }

    DDS::DynamicData_var next;
    DDS::ReturnCode_t rc = current_container->get_complex_value(next, current_id);
    if (rc != DDS::RETCODE_OK) {
      return rc;
    }
    current_container = next;
  }
  container = current_container;

  return DDS::RETCODE_OK;
}

get_member_from_type()

DDS::ReturnCode_t OpenDDS::XTypes::MemberPath::get_member_from_type	(	DDS::DynamicType_ptr	type,
		DDS::DynamicTypeMember_var &	member
	)

Definition at line 272 of file XTypes/Utils.cpp.

References OpenDDS::XTypes::get_base_type(), DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ILLEGAL_OPERATION, and DDS::RETCODE_OK.

{
  member = 0;
  if (ids.empty()) {
    return DDS::RETCODE_ILLEGAL_OPERATION;
  }

  DDS::DynamicType_var base_type = get_base_type(type);
  if (!base_type) {
    return DDS::RETCODE_BAD_PARAMETER;
  }

  MemberIdVec::iterator it = ids.begin();
  DDS::DynamicType_var current_type = DDS::DynamicType::_duplicate(type);
  DDS::DynamicTypeMember_var current_member;
  while (true) {
    DDS::ReturnCode_t rc = current_type->get_member(current_member, *it);
    if (rc != DDS::RETCODE_OK) {
      return rc;
    }

    if (++it == ids.end()) {
      break;
    }

    DDS::MemberDescriptor_var md;
    rc = current_member->get_descriptor(md);
    if (rc != DDS::RETCODE_OK) {
      return rc;
    }
    DDS::DynamicType_var next = get_base_type(md->type());
    if (!next) {
      return DDS::RETCODE_BAD_PARAMETER;
    }
    current_type = next;
  }
  member = current_member;

  return DDS::RETCODE_OK;
}

id()

MemberPath& OpenDDS::XTypes::MemberPath::id ( DDS::MemberId  id )

inline

Definition at line 101 of file XTypes/Utils.h.

Referenced by get_member_from_data().

  {
    ids.push_back(id);
    return *this;
  }

level()

size_t OpenDDS::XTypes::MemberPath::level ( ) const

inline

Definition at line 107 of file XTypes/Utils.h.

References OpenDDS::XTypes::OPENDDS_VECTOR().

Referenced by get_member_from_data().

{ return ids.size(); }

OPENDDS_VECTOR()

typedef OpenDDS::XTypes::MemberPath::OPENDDS_VECTOR

(

DDS::MemberId

)

resolve_string_path()

DDS::ReturnCode_t OpenDDS::XTypes::MemberPath::resolve_string_path	(	DDS::DynamicType_ptr	type,
		const DCPS::String &	path
	)

Definition at line 227 of file XTypes/Utils.cpp.

References ACE_ERROR, OpenDDS::XTypes::get_base_type(), OpenDDS::XTypes::MemberPathParser::get_next_subpath(), OpenDDS::XTypes::MemberPathParser::in_subscript, LM_NOTICE, OpenDDS::DCPS::log_level, OpenDDS::DCPS::LogLevel::Notice, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_OK, DDS::RETCODE_UNSUPPORTED, and OpenDDS::XTypes::MemberPathParser::subpath.

{
  DDS::DynamicType_var current_type = get_base_type(type);
  if (!current_type) {
    return DDS::RETCODE_BAD_PARAMETER;
  }

  MemberPathParser parser(path);
  while (parser.get_next_subpath()) {
    if (parser.in_subscript) {
      if (log_level >= LogLevel::Notice) {
        ACE_ERROR((LM_NOTICE, "(%P|%t) NOTICE: MemberPath::resolve_string_path: "
          "given \"%C\", which contains subscripts and these are currently not supported\n",
          path.c_str()));
      }
      return DDS::RETCODE_UNSUPPORTED;
    }
    DDS::DynamicTypeMember_var dtm;
    DDS::ReturnCode_t rc = current_type->get_member_by_name(dtm, parser.subpath.c_str());
    if (rc != DDS::RETCODE_OK) {
      return rc;
    }
    id(dtm->get_id());

    DDS::MemberDescriptor_var md;
    rc = dtm->get_descriptor(md);
    if (rc != DDS::RETCODE_OK) {
      return rc;
    }
    DDS::DynamicType_var next = get_base_type(md->type());
    if (!next) {
      return DDS::RETCODE_BAD_PARAMETER;
    }
    current_type = next;
  }

  if (log_level >= LogLevel::Notice) {
    ACE_ERROR((LM_NOTICE, "(%P|%t) NOTICE: MemberPath::resolve_string_path: "
      "parser failed to parse \"%C\"\n", path.c_str()));
    return DDS::RETCODE_OK;
  }

  return DDS::RETCODE_BAD_PARAMETER;
}

Member Data Documentation

ids

MemberIdVec OpenDDS::XTypes::MemberPath::ids

Definition at line 89 of file XTypes/Utils.h.

---

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

• XTypes/Utils.h
• XTypes/Utils.cpp