Ice 3.7 C++11 API Reference
Public Types | Public Member Functions | Static Public Member Functions | List of all members
IceGrid::FileParser Class Referenceabstract

icegridadmin provides a FileParser object to transform XML files into ApplicationDescriptor objects. More...

#include <IceGrid/IceGrid.h>

Inheritance diagram for IceGrid::FileParser:
Inheritance graph
[legend]
Collaboration diagram for IceGrid::FileParser:
Collaboration graph
[legend]

Public Types

using ProxyType = FileParserPrx
 

Public Member Functions

virtual ::std::string ice_id (const ::Ice::Current &current) const override
 Obtains a Slice type ID representing the most-derived interface supported by this object. More...
 
virtual ::std::vector<::std::string > ice_ids (const ::Ice::Current &current) const override
 Obtains a list of the Slice type IDs representing the interfaces supported by this object. More...
 
virtual bool ice_isA (::std::string id, const ::Ice::Current &current) const override
 Determines whether this object supports an interface with the given Slice type ID. More...
 
virtual ApplicationDescriptor parse (::std::string xmlFile, ::std::shared_ptr< AdminPrx > adminProxy, const ::Ice::Current &current)=0
 Parse a file. More...
 
- Public Member Functions inherited from Ice::Object
virtual bool ice_dispatch (Ice::Request &request, std::function< bool()> response=nullptr, std::function< bool(std::exception_ptr)> error=nullptr)
 Dispatches an invocation to a servant. More...
 
virtual std::string ice_id (const Current &current) const
 Returns the Slice type ID of the most-derived interface supported by this object. More...
 
virtual std::vector< std::string > ice_ids (const Current &current) const
 Returns the Slice type IDs of the interfaces supported by this object. More...
 
virtual bool ice_isA (std::string s, const Current &current) const
 Tests whether this object supports a specific Slice interface. More...
 
virtual void ice_ping (const Current &current) const
 Tests whether this object can be reached. More...
 
virtual ~Object ()=default
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID corresponding to this class. More...
 
- Static Public Member Functions inherited from Ice::Object
static const std::string & ice_staticId ()
 Obtains the Slice type ID of this type. More...
 

Detailed Description

icegridadmin provides a FileParser object to transform XML files into ApplicationDescriptor objects.

Member Typedef Documentation

◆ ProxyType

Member Function Documentation

◆ ice_id()

virtual ::std::string IceGrid::FileParser::ice_id ( const ::Ice::Current current) const
override

Obtains a Slice type ID representing the most-derived interface supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A fully-scoped type ID.

◆ ice_ids()

virtual ::std::vector<::std::string> IceGrid::FileParser::ice_ids ( const ::Ice::Current current) const
override

Obtains a list of the Slice type IDs representing the interfaces supported by this object.

Parameters
currentThe Current object for the invocation.
Returns
A list of fully-scoped type IDs.

◆ ice_isA()

virtual bool IceGrid::FileParser::ice_isA ( ::std::string  id,
const ::Ice::Current current 
) const
overridevirtual

Determines whether this object supports an interface with the given Slice type ID.

Parameters
idThe fully-scoped Slice type ID.
currentThe Current object for the invocation.
Returns
True if this object supports the interface, false, otherwise.

◆ ice_staticId()

static const ::std::string& IceGrid::FileParser::ice_staticId ( )
static

Obtains the Slice type ID corresponding to this class.

Returns
A fully-scoped type ID.

◆ parse()

virtual ApplicationDescriptor IceGrid::FileParser::parse ( ::std::string  xmlFile,
::std::shared_ptr< AdminPrx adminProxy,
const ::Ice::Current current 
)
pure virtual

Parse a file.

Parameters
xmlFileFull pathname to the file.
adminProxyAn Admin proxy, used only to retrieve default templates when needed. May be null.
currentThe Current object for the invocation.
Returns
The application descriptor.
Exceptions
IceGrid::ParseExceptionRaised if an error occurred during parsing.

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