OpenDDS::DCPS::QOS_XML_Loader Class Reference

#include <QOS_XML_Loader.h>

Collaboration diagram for OpenDDS::DCPS::QOS_XML_Loader:

Public Member Functions
	QOS_XML_Loader (XML::XML_Error_Handler *error_handler=0)
	~QOS_XML_Loader ()
DDS::ReturnCode_t	init (const ACE_TCHAR *qos_profile)
DDS::ReturnCode_t	get_datawriter_qos (DDS::DataWriterQos &dw_qos, const ACE_TCHAR *qos_profile, const ACE_TCHAR *topic_name)
DDS::ReturnCode_t	get_datareader_qos (DDS::DataReaderQos &dr_qos, const ACE_TCHAR *qos_profile, const ACE_TCHAR *topic_name)
DDS::ReturnCode_t	get_publisher_qos (DDS::PublisherQos &pub_qos, const ACE_TCHAR *qos_profile)
DDS::ReturnCode_t	get_subscriber_qos (DDS::SubscriberQos &sub_qos, const ACE_TCHAR *qos_profile)
DDS::ReturnCode_t	get_topic_qos (DDS::TopicQos &topic_qos, const ACE_TCHAR *qos_profile, const ACE_TCHAR *topic_name)
DDS::ReturnCode_t	get_participant_qos (DDS::DomainParticipantQos &part_qos, const ACE_TCHAR *qos_profile)

Private Member Functions
ACE_TString	get_xml_file_name (const ACE_TCHAR *qos_profile)
ACE_TString	get_profile_name (const ACE_TCHAR *qos_profile)

Private Attributes
QOS_XML_File_Handler	xml_file_

Detailed Description

Definition at line 18 of file QOS_XML_Loader.h.

Constructor & Destructor Documentation

QOS_XML_Loader()

OpenDDS::DCPS::QOS_XML_Loader::QOS_XML_Loader

(

XML::XML_Error_Handler *

error_handler = 0

)

Pass an optional which is called back when there are any errors parsing the input XML. The QOS_XML_Loader will assume ownership when a pointer is passed

Definition at line 11 of file QOS_XML_Loader.cpp.

    : xml_file_ (error_handler)
  {
  }

~QOS_XML_Loader()

OpenDDS::DCPS::QOS_XML_Loader::~QOS_XML_Loader

(

)

Definition at line 16 of file QOS_XML_Loader.cpp.

  {
  }

Member Function Documentation

get_datareader_qos()

DDS::ReturnCode_t OpenDDS::DCPS::QOS_XML_Loader::get_datareader_qos	(	DDS::DataReaderQos &	dr_qos,
		const ACE_TCHAR *	qos_profile,
		const ACE_TCHAR *	topic_name
	)

These methods have DDS QOS, a profile and a topic_name as input.

The DDS QOS is passed by reference. This library fills this QOS and will return it to the callee.

qos_profile should be the same profile string as the one passed to the init method.

If the profile name is correct, the methods will invoke the corresponding method in the XML_File_Intf class.

Definition at line 180 of file QOS_XML_Loader.cpp.

References ACE_DEBUG, ACE_ERROR, ACE_TEXT(), ACE_String_Base< char >::c_str(), OpenDDS::DCPS::DCPS_debug_level, ACE_String_Base< char >::empty(), OpenDDS::DCPS::QOS_XML_Handler::get_datareader_qos(), get_profile_name(), LM_DEBUG, LM_ERROR, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ERROR, DDS::RETCODE_OK, and xml_file_.

  {
    if (!qos_profile)
      {
        if (DCPS_debug_level > 9)
          {
            ACE_DEBUG((LM_DEBUG,
              ACE_TEXT("QOS_XML_Loader::get_datareader_qos - ")
              ACE_TEXT("No QOS profile provided. Can't do anything, ")
              ACE_TEXT("returning\n")));
          }

        return DDS::RETCODE_OK;
      }

    const ACE_TString profile_name = get_profile_name(qos_profile);

    if (profile_name.empty())
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_datareader_qos - ")
              ACE_TEXT("Error parsing profile string <%s>, returning.\n"),
              qos_profile));
          }
        return ::DDS::RETCODE_BAD_PARAMETER;
      }

    DDS::ReturnCode_t retcode = DDS::RETCODE_OK;

    try
      {
        retcode = xml_file_.get_datareader_qos(dr_qos,
                                               profile_name.c_str(),
                                               topic_name);
      }
    catch (...)
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_datareader_qos - ")
              ACE_TEXT("Caught unexpected exception.\n")));
          }
        retcode = ::DDS::RETCODE_ERROR;
      }

    return retcode;
  }

get_datawriter_qos()

DDS::ReturnCode_t OpenDDS::DCPS::QOS_XML_Loader::get_datawriter_qos	(	DDS::DataWriterQos &	dw_qos,
		const ACE_TCHAR *	qos_profile,
		const ACE_TCHAR *	topic_name
	)

These methods have DDS QOS, a profile and a topic_name as input.

The DDS QOS is passed by reference. This library fills this QOS and will return it to the callee.

qos_profile should be the same profile string as the one passed to the init method.

If the profile name is correct, the methods will invoke the corresponding method in the XML_File_Intf class.

Definition at line 125 of file QOS_XML_Loader.cpp.

References ACE_DEBUG, ACE_ERROR, ACE_TEXT(), ACE_String_Base< char >::c_str(), OpenDDS::DCPS::DCPS_debug_level, ACE_String_Base< char >::empty(), OpenDDS::DCPS::QOS_XML_Handler::get_datawriter_qos(), get_profile_name(), LM_DEBUG, LM_ERROR, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ERROR, DDS::RETCODE_OK, and xml_file_.

  {
    if (!qos_profile)
      {
        if (DCPS_debug_level > 9)
          {
            ACE_DEBUG((LM_DEBUG,
              ACE_TEXT("QOS_XML_Loader::get_datawriter_qos - ")
              ACE_TEXT("No QOS profile provided. Can't do anything, ")
              ACE_TEXT("returning\n")));
          }

        return DDS::RETCODE_OK;
      }

    const ACE_TString profile_name = get_profile_name(qos_profile);

    if (profile_name.empty())
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_datawriter_qos - ")
              ACE_TEXT("Error parsing profile string <%s>, returning.\n"),
              qos_profile));
          }
        return ::DDS::RETCODE_BAD_PARAMETER;
      }

    DDS::ReturnCode_t retcode = DDS::RETCODE_OK;

    try
      {
        retcode = xml_file_.get_datawriter_qos(dw_qos,
                                               profile_name.c_str(),
                                               topic_name);
      }
    catch (...)
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_datawriter_qos - ")
              ACE_TEXT("Caught unexpected exception.\n")));
          }
        retcode = DDS::RETCODE_ERROR;
      }

    return retcode;
  }

get_participant_qos()

DDS::ReturnCode_t OpenDDS::DCPS::QOS_XML_Loader::get_participant_qos	(	DDS::DomainParticipantQos &	part_qos,
		const ACE_TCHAR *	qos_profile
	)

These methods have DDS QOS, a profile and a topic_name as input.

The DDS QOS is passed by reference. This library fills this QOS and will return it to the callee.

qos_profile should be the same profile string as the one passed to the init method.

If the profile name is correct, the methods will invoke the corresponding method in the XML_File_Intf class.

Definition at line 394 of file QOS_XML_Loader.cpp.

References ACE_DEBUG, ACE_ERROR, ACE_TEXT(), ACE_String_Base< char >::c_str(), OpenDDS::DCPS::DCPS_debug_level, ACE_String_Base< char >::empty(), OpenDDS::DCPS::QOS_XML_Handler::get_participant_qos(), get_profile_name(), LM_DEBUG, LM_ERROR, OPENDDS_END_VERSIONED_NAMESPACE_DECL, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ERROR, DDS::RETCODE_OK, and xml_file_.

  {
    if (!qos_profile)
      {
        if (DCPS_debug_level > 9)
          {
            ACE_DEBUG((LM_DEBUG,
              ACE_TEXT("QOS_XML_Loader::get_participant_qos - ")
              ACE_TEXT("No QOS profile provided. Can't do anything, ")
              ACE_TEXT("returning\n")));
          }

        return DDS::RETCODE_OK;
      }

    const ACE_TString profile_name = get_profile_name(qos_profile);

    if (profile_name.empty())
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_participant_qos - ")
              ACE_TEXT("Error parsing profile string <%s>, returning.\n"),
              qos_profile));
          }
        return ::DDS::RETCODE_BAD_PARAMETER;
      }

    DDS::ReturnCode_t retcode = DDS::RETCODE_OK;

    try
      {
        retcode = xml_file_.get_participant_qos(part_qos, profile_name.c_str());
      }
    catch (...)
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_participant_qos - ")
              ACE_TEXT("Caught unexpected exception.\n")));
          }
        retcode = DDS::RETCODE_ERROR;
      }

    return retcode;
  }

get_profile_name()

ACE_TString OpenDDS::DCPS::QOS_XML_Loader::get_profile_name ( const ACE_TCHAR *  qos_profile )

private

Definition at line 54 of file QOS_XML_Loader.cpp.

References ACE_ERROR, OpenDDS::DCPS::DCPS_debug_level, ACE_Tokenizer_T< class >::delimiter_replace(), ACE_OS::free(), LM_ERROR, ACE_Tokenizer_T< class >::next(), and ACE_OS::strdup().

Referenced by get_datareader_qos(), get_datawriter_qos(), get_participant_qos(), get_publisher_qos(), get_subscriber_qos(), and get_topic_qos().

  {
    if (qos_profile)
      {
        ACE_TCHAR* buf = ACE_OS::strdup(qos_profile);
        ACE_Tokenizer_T<ACE_TCHAR> tok(buf);
        tok.delimiter_replace('#', 0);
        const ACE_TCHAR * lib_name = tok.next();
        const ACE_TCHAR * prof_name = tok.next();

        if (lib_name == 0 || prof_name == 0 || tok.next() != 0)
          {
            ACE_OS::free(buf);
            if (DCPS_debug_level > 5)
              {
                ACE_ERROR((LM_ERROR,
                             "get_profile_name <%s> - "
                             "Error: malformed qos_profile. Expected format: "
                             "<xml_file_base_name>#<profile_name>\n",
                             qos_profile));
              }
            return ACE_TString();
          }

        ACE_TString ret(prof_name);
        ACE_OS::free(buf);
        return ret;
      }

    return ACE_TString();
  }

get_publisher_qos()

DDS::ReturnCode_t OpenDDS::DCPS::QOS_XML_Loader::get_publisher_qos	(	DDS::PublisherQos &	pub_qos,
		const ACE_TCHAR *	qos_profile
	)

These methods have DDS QOS, a profile and a topic_name as input.

The DDS QOS is passed by reference. This library fills this QOS and will return it to the callee.

qos_profile should be the same profile string as the one passed to the init method.

If the profile name is correct, the methods will invoke the corresponding method in the XML_File_Intf class.

Definition at line 235 of file QOS_XML_Loader.cpp.

References ACE_DEBUG, ACE_ERROR, ACE_TEXT(), ACE_String_Base< char >::c_str(), OpenDDS::DCPS::DCPS_debug_level, ACE_String_Base< char >::empty(), get_profile_name(), OpenDDS::DCPS::QOS_XML_Handler::get_publisher_qos(), LM_DEBUG, LM_ERROR, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ERROR, DDS::RETCODE_OK, and xml_file_.

  {
    if (!qos_profile)
      {
        if (DCPS_debug_level > 9)
          {
            ACE_DEBUG((LM_DEBUG,
              ACE_TEXT("QOS_XML_Loader::get_publisher_qos - ")
              ACE_TEXT("No QOS profile provided. Can't do anything, ")
              ACE_TEXT("returning\n")));
          }

        return DDS::RETCODE_OK;
      }

    const ACE_TString profile_name = get_profile_name(qos_profile);

    if (profile_name.empty())
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_publisher_qos - ")
              ACE_TEXT("Error parsing profile string <%s>, returning.\n"),
              qos_profile));
          }
        return ::DDS::RETCODE_BAD_PARAMETER;
      }

    DDS::ReturnCode_t retcode = DDS::RETCODE_OK;

    try
      {
        retcode = xml_file_.get_publisher_qos(pub_qos, profile_name.c_str());
      }
    catch (...)
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_publisher_qos - ")
              ACE_TEXT("Caught unexpected exception.\n")));
          }
        retcode = DDS::RETCODE_ERROR;
      }

    return retcode;
  }

get_subscriber_qos()

DDS::ReturnCode_t OpenDDS::DCPS::QOS_XML_Loader::get_subscriber_qos	(	DDS::SubscriberQos &	sub_qos,
		const ACE_TCHAR *	qos_profile
	)

These methods have DDS QOS, a profile and a topic_name as input.

The DDS QOS is passed by reference. This library fills this QOS and will return it to the callee.

qos_profile should be the same profile string as the one passed to the init method.

If the profile name is correct, the methods will invoke the corresponding method in the XML_File_Intf class.

Definition at line 287 of file QOS_XML_Loader.cpp.

References ACE_DEBUG, ACE_ERROR, ACE_TEXT(), ACE_String_Base< char >::c_str(), OpenDDS::DCPS::DCPS_debug_level, ACE_String_Base< char >::empty(), get_profile_name(), OpenDDS::DCPS::QOS_XML_Handler::get_subscriber_qos(), LM_DEBUG, LM_ERROR, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ERROR, DDS::RETCODE_OK, and xml_file_.

  {
    if (!qos_profile)
      {
        if (DCPS_debug_level > 9)
          {
            ACE_DEBUG((LM_DEBUG,
              ACE_TEXT("QOS_XML_Loader::get_subscriber_qos - ")
              ACE_TEXT("No QOS profile provided. Can't do anything, ")
              ACE_TEXT("returning\n")));
          }

        return DDS::RETCODE_OK;
      }

    const ACE_TString profile_name = get_profile_name(qos_profile);

    if (profile_name.empty())
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_subscriber_qos - ")
              ACE_TEXT("Error parsing profile string <%s>, returning.\n"),
              qos_profile));
          }
        return ::DDS::RETCODE_BAD_PARAMETER;
      }

    DDS::ReturnCode_t retcode = DDS::RETCODE_OK;

    try
      {
        retcode = xml_file_.get_subscriber_qos(sub_qos, profile_name.c_str());
      }
    catch (...)
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_subscriber_qos - ")
              ACE_TEXT("Caught unexpected exception.\n")));
          }
        retcode = DDS::RETCODE_ERROR;
      }

    return retcode;
  }

get_topic_qos()

DDS::ReturnCode_t OpenDDS::DCPS::QOS_XML_Loader::get_topic_qos	(	DDS::TopicQos &	topic_qos,
		const ACE_TCHAR *	qos_profile,
		const ACE_TCHAR *	topic_name
	)

These methods have DDS QOS, a profile and a topic_name as input.

The DDS QOS is passed by reference. This library fills this QOS and will return it to the callee.

qos_profile should be the same profile string as the one passed to the init method.

If the profile name is correct, the methods will invoke the corresponding method in the XML_File_Intf class.

Definition at line 339 of file QOS_XML_Loader.cpp.

References ACE_DEBUG, ACE_ERROR, ACE_TEXT(), ACE_String_Base< char >::c_str(), OpenDDS::DCPS::DCPS_debug_level, ACE_String_Base< char >::empty(), get_profile_name(), OpenDDS::DCPS::QOS_XML_Handler::get_topic_qos(), LM_DEBUG, LM_ERROR, DDS::RETCODE_BAD_PARAMETER, DDS::RETCODE_ERROR, DDS::RETCODE_OK, and xml_file_.

  {
    if (!qos_profile)
      {
        if (DCPS_debug_level > 9)
          {
            ACE_DEBUG((LM_DEBUG,
              ACE_TEXT("QOS_XML_Loader::get_topic_qos - ")
              ACE_TEXT("No QOS profile provided. Can't do anything, ")
              ACE_TEXT("returning\n")));
          }

        return DDS::RETCODE_OK;
      }

    const ACE_TString profile_name = get_profile_name(qos_profile);

    if (profile_name.empty())
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_topic_qos - ")
              ACE_TEXT("Error parsing profile string <%s>, returning.\n"),
              qos_profile));
          }
        return ::DDS::RETCODE_BAD_PARAMETER;
      }

    DDS::ReturnCode_t retcode = DDS::RETCODE_OK;

    try
      {
        retcode = xml_file_.get_topic_qos(topic_qos,
                                          profile_name.c_str(),
                                          topic_name);
      }
    catch (...)
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::get_topic_qos - ")
              ACE_TEXT("Caught unexpected exception.\n")));
          }
        retcode = DDS::RETCODE_ERROR;
      }

    return retcode;
  }

get_xml_file_name()

ACE_TString OpenDDS::DCPS::QOS_XML_Loader::get_xml_file_name ( const ACE_TCHAR *  qos_profile )

private

Definition at line 21 of file QOS_XML_Loader.cpp.

References ACE_ERROR, ACE_TEXT(), OpenDDS::DCPS::DCPS_debug_level, ACE_Tokenizer_T< class >::delimiter_replace(), ACE_OS::free(), LM_ERROR, ACE_Tokenizer_T< class >::next(), and ACE_OS::strdup().

Referenced by init().

  {
    if (qos_profile)
      {
        ACE_TCHAR* buf = ACE_OS::strdup(qos_profile);
        ACE_Tokenizer_T<ACE_TCHAR> tok(buf);
        tok.delimiter_replace('#', 0);
        const ACE_TCHAR * file_name = tok.next();

        if (file_name == 0)
          {
            ACE_OS::free(buf);
            if (DCPS_debug_level > 5)
              {
                ACE_ERROR((LM_ERROR,
                           "get_xml_file_name <%s> - "
                           "Error: malformed qos_profile. Expected format: "
                           "<xml_file_base_name>#<profile_name>\n",
                           qos_profile));
              }
            return ACE_TString();
          }

        ACE_TString ret(file_name);
        ret += ACE_TEXT(".xml");
        ACE_OS::free(buf);
        return ret;
      }

    return ACE_TString();
  }

init()

DDS::ReturnCode_t OpenDDS::DCPS::QOS_XML_Loader::init

(

const ACE_TCHAR *

qos_profile

)

init

qos_profile profile should be formatted like:

qos_base_file_name_without_extension::profile_name_in_xml_file

Init parses this string and will append ".xml" to qos_base_file_name_without_extension. It'll than invoke the init method on the XML_File_Intf class.

Definition at line 88 of file QOS_XML_Loader.cpp.

References ACE_ERROR, ACE_TEXT(), OpenDDS::DCPS::QOS_XML_File_Handler::add_search_path(), ACE_String_Base< char >::c_str(), OpenDDS::DCPS::DCPS_debug_level, ACE_String_Base< char >::empty(), get_xml_file_name(), OpenDDS::DCPS::QOS_XML_File_Handler::init(), LM_ERROR, DDS::RETCODE_BAD_PARAMETER, and xml_file_.

  {
    if (!qos_profile)
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::init - ")
              ACE_TEXT("Passed an empty qos_profile, returning.\n")));
          }
        return ::DDS::RETCODE_BAD_PARAMETER;
      }

    const ACE_TString filename = get_xml_file_name(qos_profile);

    if (filename.empty())
      {
        if (DCPS_debug_level > 5)
          {
            ACE_ERROR((LM_ERROR,
              ACE_TEXT("QOS_XML_Loader::init - ")
              ACE_TEXT("Unable to extract a file name from <%s>, returning.\n"),
              qos_profile));
          }
        return ::DDS::RETCODE_BAD_PARAMETER;
      }

    xml_file_.add_search_path(
      ACE_TEXT("DDS_ROOT"),
      ACE_TEXT("/docs/schema/"));

    DDS::ReturnCode_t const retcode =  xml_file_.init(filename.c_str());

    return retcode;
  }

Member Data Documentation

xml_file_

QOS_XML_File_Handler OpenDDS::DCPS::QOS_XML_Loader::xml_file_

private

Definition at line 86 of file QOS_XML_Loader.h.

Referenced by get_datareader_qos(), get_datawriter_qos(), get_participant_qos(), get_publisher_qos(), get_subscriber_qos(), get_topic_qos(), and init().

---

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

• QOS_XML_Loader.h
• QOS_XML_Loader.cpp