Fast RTPS  Version 2.14.1
Fast RTPS
Loading...
Searching...
No Matches

Class XMLEndpointParser used to parse the XML file that contains information about remote endpoints. More...

#include <XMLEndpointParser.h>

Inheritance diagram for XMLEndpointParser:

Public Member Functions

 XMLEndpointParser ()
 
virtual ~XMLEndpointParser ()
 
XMLP_ret loadXMLFile (std::string &filename)
 Load the XML file.
 
XMLP_ret loadXMLNode (tinyxml2::XMLDocument &doc)
 Load the XML node.
 
void loadXMLParticipantEndpoint (tinyxml2::XMLElement *xml_endpoint, StaticRTPSParticipantInfo *pdata)
 
XMLP_ret loadXMLReaderEndpoint (tinyxml2::XMLElement *xml_endpoint, StaticRTPSParticipantInfo *pdata)
 Load a Reader endpoint.
 
XMLP_ret loadXMLWriterEndpoint (tinyxml2::XMLElement *xml_endpoint, StaticRTPSParticipantInfo *pdata)
 Load a Writer endpoint.
 
XMLP_ret lookforReader (const char *partname, uint16_t id, rtps::ReaderProxyData **rdataptr)
 Look for a reader in the previously loaded endpoints.
 
XMLP_ret lookforWriter (const char *partname, uint16_t id, rtps::WriterProxyData **wdataptr)
 Look for a writer in the previously loaded endpoints.
 

Detailed Description

Class XMLEndpointParser used to parse the XML file that contains information about remote endpoints.

Constructor & Destructor Documentation

◆ XMLEndpointParser()

◆ ~XMLEndpointParser()

virtual ~XMLEndpointParser ( )
virtual

Member Function Documentation

◆ loadXMLFile()

XMLP_ret loadXMLFile ( std::string &  filename)

Load the XML file.

Parameters
filenameName or data of the file to load and parse. The string could contain a filename (file://) or the XML content directly (data://), filename assumed if neither
Returns
True if correct.

◆ loadXMLNode()

XMLP_ret loadXMLNode ( tinyxml2::XMLDocument &  doc)

Load the XML node.

Parameters
docNode to parse.
Returns
True if correct.

◆ loadXMLParticipantEndpoint()

void loadXMLParticipantEndpoint ( tinyxml2::XMLElement *  xml_endpoint,
StaticRTPSParticipantInfo pdata 
)

◆ loadXMLReaderEndpoint()

XMLP_ret loadXMLReaderEndpoint ( tinyxml2::XMLElement *  xml_endpoint,
StaticRTPSParticipantInfo pdata 
)

Load a Reader endpoint.

Parameters
xml_endpointReference of a tree child for a reader.
pdataPointer to the RTPSParticipantInfo where the reader must be added.
Returns
True if correctly added.

◆ loadXMLWriterEndpoint()

XMLP_ret loadXMLWriterEndpoint ( tinyxml2::XMLElement *  xml_endpoint,
StaticRTPSParticipantInfo pdata 
)

Load a Writer endpoint.

Parameters
xml_endpointReference of a tree child for a writer.
pdataPointer to the RTPSParticipantInfo where the reader must be added.
Returns
True if correctly added.

◆ lookforReader()

XMLP_ret lookforReader ( const char *  partname,
uint16_t  id,
rtps::ReaderProxyData **  rdataptr 
)

Look for a reader in the previously loaded endpoints.

Parameters
[in]partnameRTPSParticipant name
[in]idId of the reader
[out]rdataptrPointer to pointer to return the information.
Returns
True if found.

◆ lookforWriter()

XMLP_ret lookforWriter ( const char *  partname,
uint16_t  id,
rtps::WriterProxyData **  wdataptr 
)

Look for a writer in the previously loaded endpoints.

Parameters
[in]partnameRTPSParticipant name
[in]idId of the writer
[out]wdataptrPointer to pointer to return the information.
Returns
True if found

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