Assimp  v4.1. (December 2018)
Assimp::CXMLReaderImpl Class Reference

Inherits Assimp::FIReader.

Public Member Functions

 CXMLReaderImpl (std::unique_ptr< irr::io::IIrrXMLReader< char, irr::io::IXMLBase >> reader_)
 Constructor. More...
 
virtual int getAttributeCount () const
 Returns attribute count of the current XML node. More...
 
virtual std::shared_ptr< const FIValuegetAttributeEncodedValue (const char *) const
 
virtual std::shared_ptr< const FIValuegetAttributeEncodedValue (int) const
 
virtual const char * getAttributeName (int idx) const
 Returns name of an attribute. More...
 
virtual const char * getAttributeValue (const char *name) const
 Returns the value of an attribute. More...
 
virtual const char * getAttributeValue (int idx) const
 Returns the value of an attribute. More...
 
virtual float getAttributeValueAsFloat (const char *name) const
 Returns the value of an attribute as float. More...
 
virtual float getAttributeValueAsFloat (int idx) const
 Returns the value of an attribute as float. More...
 
virtual int getAttributeValueAsInt (const char *name) const
 Returns the value of an attribute as integer. More...
 
virtual int getAttributeValueAsInt (int idx) const
 Returns the value of an attribute as integer. More...
 
virtual const char * getAttributeValueSafe (const char *name) const
 Returns the value of an attribute in a safe way. More...
 
virtual const char * getNodeData () const
 Returns data of the current node. More...
 
virtual const char * getNodeName () const
 Returns the name of the current node. More...
 
virtual irr::io::EXML_NODE getNodeType () const
 Returns the type of the current XML node. More...
 
virtual irr::io::ETEXT_FORMAT getParserFormat () const
 Returns format of the strings returned by the parser. More...
 
virtual irr::io::ETEXT_FORMAT getSourceFormat () const
 Returns format of the source xml file. More...
 
virtual bool isEmptyElement () const
 Returns if an element is an empty element, like <foo> More...
 
virtual bool read ()
 Reads forward to the next xml node. More...
 
virtual void registerDecoder (const std::string &, std::unique_ptr< FIDecoder >)
 
virtual void registerVocabulary (const std::string &, const FIVocabulary *)
 
virtual ~CXMLReaderImpl ()
 
- Public Member Functions inherited from Assimp::FIReader
virtual ~FIReader ()
 
- Public Member Functions inherited from irr::io::IIrrXMLReader< char, irr::io::IXMLBase >
virtual ~IIrrXMLReader ()
 Destructor. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from Assimp::FIReader
static std::unique_ptr< FIReadercreate (IOStream *stream)
 

Constructor & Destructor Documentation

◆ CXMLReaderImpl()

Assimp::CXMLReaderImpl::CXMLReaderImpl ( std::unique_ptr< irr::io::IIrrXMLReader< char, irr::io::IXMLBase >>  reader_)
inline

Constructor.

◆ ~CXMLReaderImpl()

virtual Assimp::CXMLReaderImpl::~CXMLReaderImpl ( )
inlinevirtual

Member Function Documentation

◆ getAttributeCount()

virtual int Assimp::CXMLReaderImpl::getAttributeCount ( ) const
inlinevirtual

Returns attribute count of the current XML node.

This is usually non null if the current node is EXN_ELEMENT, and the element has attributes.

Returns
Returns amount of attributes of this xml node.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getAttributeEncodedValue() [1/2]

virtual std::shared_ptr<const FIValue> Assimp::CXMLReaderImpl::getAttributeEncodedValue ( const char *  ) const
inlinevirtual

Implements Assimp::FIReader.

◆ getAttributeEncodedValue() [2/2]

virtual std::shared_ptr<const FIValue> Assimp::CXMLReaderImpl::getAttributeEncodedValue ( int  ) const
inlinevirtual

Implements Assimp::FIReader.

◆ getAttributeName()

virtual const char* Assimp::CXMLReaderImpl::getAttributeName ( int  idx) const
inlinevirtual

Returns name of an attribute.

Parameters
idxZero based index, should be something between 0 and getAttributeCount()-1.
Returns
Name of the attribute, 0 if an attribute with this index does not exist.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getAttributeValue() [1/2]

virtual const char* Assimp::CXMLReaderImpl::getAttributeValue ( const char *  name) const
inlinevirtual

Returns the value of an attribute.

Parameters
nameName of the attribute.
Returns
Value of the attribute, 0 if an attribute with this name does not exist.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getAttributeValue() [2/2]

virtual const char* Assimp::CXMLReaderImpl::getAttributeValue ( int  idx) const
inlinevirtual

Returns the value of an attribute.

Parameters
idxZero based index, should be something between 0 and getAttributeCount()-1.
Returns
Value of the attribute, 0 if an attribute with this index does not exist.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getAttributeValueAsFloat() [1/2]

virtual float Assimp::CXMLReaderImpl::getAttributeValueAsFloat ( const char *  name) const
inlinevirtual

Returns the value of an attribute as float.

Parameters
nameName of the attribute.
Returns
Value of the attribute as float, and 0 if an attribute with this name does not exist or the value could not be interpreted as float.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getAttributeValueAsFloat() [2/2]

virtual float Assimp::CXMLReaderImpl::getAttributeValueAsFloat ( int  idx) const
inlinevirtual

Returns the value of an attribute as float.

Parameters
idxZero based index, should be something between 0 and getAttributeCount()-1.
Returns
Value of the attribute as float, and 0 if an attribute with this index does not exist or the value could not be interpreted as float.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getAttributeValueAsInt() [1/2]

virtual int Assimp::CXMLReaderImpl::getAttributeValueAsInt ( const char *  name) const
inlinevirtual

Returns the value of an attribute as integer.

Parameters
nameName of the attribute.
Returns
Value of the attribute as integer, and 0 if an attribute with this name does not exist or the value could not be interpreted as integer.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getAttributeValueAsInt() [2/2]

virtual int Assimp::CXMLReaderImpl::getAttributeValueAsInt ( int  idx) const
inlinevirtual

Returns the value of an attribute as integer.

Parameters
idxZero based index, should be something between 0 and getAttributeCount()-1.
Returns
Value of the attribute as integer, and 0 if an attribute with this index does not exist or the value could not be interpreted as integer.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getAttributeValueSafe()

virtual const char* Assimp::CXMLReaderImpl::getAttributeValueSafe ( const char *  name) const
inlinevirtual

Returns the value of an attribute in a safe way.

Like getAttributeValue(), but does not return 0 if the attribute does not exist. An empty string ("") is returned then.

Parameters
nameName of the attribute.
Returns
Value of the attribute, and "" if an attribute with this name does not exist

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getNodeData()

virtual const char* Assimp::CXMLReaderImpl::getNodeData ( ) const
inlinevirtual

Returns data of the current node.

Only non null if the node has some data and it is of type EXN_TEXT or EXN_UNKNOWN.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getNodeName()

virtual const char* Assimp::CXMLReaderImpl::getNodeName ( ) const
inlinevirtual

Returns the name of the current node.

Only non null, if the node type is EXN_ELEMENT.

Returns
Name of the current node or 0 if the node has no name.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getNodeType()

virtual irr::io::EXML_NODE Assimp::CXMLReaderImpl::getNodeType ( ) const
inlinevirtual

Returns the type of the current XML node.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getParserFormat()

virtual irr::io::ETEXT_FORMAT Assimp::CXMLReaderImpl::getParserFormat ( ) const
inlinevirtual

Returns format of the strings returned by the parser.

This will be UTF8 for example when you created a parser with IrrXMLReaderUTF8() and UTF32 when it has been created using IrrXMLReaderUTF32. It should not be necessary to call this method and only exists for informational purposes.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ getSourceFormat()

virtual irr::io::ETEXT_FORMAT Assimp::CXMLReaderImpl::getSourceFormat ( ) const
inlinevirtual

Returns format of the source xml file.

It is not necessary to use this method because the parser will convert the input file format to the format wanted by the user when creating the parser. This method is useful to get/display additional informations.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ isEmptyElement()

virtual bool Assimp::CXMLReaderImpl::isEmptyElement ( ) const
inlinevirtual

Returns if an element is an empty element, like <foo>

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ read()

virtual bool Assimp::CXMLReaderImpl::read ( )
inlinevirtual

Reads forward to the next xml node.

Returns
Returns false, if there was no further node.

Implements irr::io::IIrrXMLReader< char, irr::io::IXMLBase >.

◆ registerDecoder()

virtual void Assimp::CXMLReaderImpl::registerDecoder ( const std::string &  ,
std::unique_ptr< FIDecoder  
)
inlinevirtual

Implements Assimp::FIReader.

◆ registerVocabulary()

virtual void Assimp::CXMLReaderImpl::registerVocabulary ( const std::string &  ,
const FIVocabulary  
)
inlinevirtual

Implements Assimp::FIReader.


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