casadi::XmlFile Class Reference

XML parser. More...

#include <xml_file.hpp>

Detailed Description

Can be used for parsing XML files into CasADi data structures.

Author

Joel Andersson

Date

2014

Extra doc: https://github.com/casadi/casadi/wiki/L_7k

Definition at line 47 of file xml_file.hpp.

Inheritance diagram for casadi::XmlFile:

Collaboration diagram for casadi::XmlFile:

Public Types
using	internal_base_type = SharedObjectInternal
using	base_type = SharedObject

Public Member Functions
	XmlFile ()
	XmlFile (const std::string &name)
	~XmlFile ()
XmlFileInternal *	operator-> ()
	Access functions of the node. More...
const XmlFileInternal *	operator-> () const
	Const access functions of the node. More...
XmlNode	parse (const std::string &filename)
void	dump (const std::string &filename, const XmlNode &node)
std::string	class_name () const
	Get class name. More...
void	disp (std::ostream &stream, bool more=false) const
	Print a description of the object. More...
std::string	get_str (bool more=false) const
	Get string representation. More...
void	print_ptr (std::ostream &stream=casadi::uout()) const
void	own (SharedObjectInternal *node)
void	assign (SharedObjectInternal *node)
	Assign the node to a node class pointer without reference counting. More...
SharedObjectInternal *	get () const
	Get a const pointer to the node. More...
casadi_int	getCount () const
	Get the reference count. More...
void	swap (GenericShared &other)
	Swap content with another instance. More...
std::string	debug_repr () const
bool	is_null () const
	Is a null pointer? More...
casadi_int	__hash__ () const
	Returns a number that is unique for a given Node. More...
GenericWeakRef< SharedObject, SharedObjectInternal > *	weak ()
	Get a weak reference to the object. More...

Static Public Member Functions
static std::string	type_name ()
	Get type name. More...
static void	load_plugin (const std::string &name)
	Load a plugin dynamically. More...
static std::string	doc (const std::string &name)
	Get solver specific documentation. More...

Protected Member Functions
void	count_up ()
void	count_down ()

Member Typedef Documentation

base_type

using casadi::SharedObject::base_type = SharedObject

inherited

Definition at line 103 of file shared_object.hpp.

internal_base_type

using casadi::SharedObject::internal_base_type = SharedObjectInternal

inherited

Definition at line 102 of file shared_object.hpp.

Constructor & Destructor Documentation

XmlFile() [1/2]

casadi::XmlFile::XmlFile

(

)

Definition at line 30 of file xml_file.cpp.

                 {
}

XmlFile() [2/2]

casadi::XmlFile::XmlFile

(

const std::string &

name

)

Definition at line 33 of file xml_file.cpp.

                                      {
  own(XmlFileInternal::getPlugin(name).creator());
}

References casadi::PluginInterface< XmlFileInternal >::getPlugin(), and casadi::GenericShared< SharedObject, SharedObjectInternal >::own().

~XmlFile()

casadi::XmlFile::~XmlFile

(

)

Definition at line 37 of file xml_file.cpp.

                  {
}

Member Function Documentation

__hash__()

casadi_int casadi::GenericShared< SharedObject , SharedObjectInternal >::__hash__

inherited

If the Object does not point to any node, "0" is returned.

Extra doc: https://github.com/casadi/casadi/wiki/L_av

Definition at line 123 of file generic_shared_impl.hpp.

                                                             {
    return reinterpret_cast<casadi_int>(get());
  }

assign()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::assign ( Internal *  node )

inherited

improper use will cause memory leaks!

Extra doc: https://github.com/casadi/casadi/wiki/L_at

Definition at line 96 of file generic_shared_impl.hpp.

                                                              {
    node = node_;
  }

class_name()

std::string casadi::SharedObject::class_name ( ) const

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_au

Definition at line 31 of file shared_object.cpp.

                                           {
    return (*this)->class_name();
  }

Referenced by casadi::FmuFunction::check_mem_count(), casadi::MXFunction::export_code_body(), and casadi::BlazingSplineFunction::merge().

count_down()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::count_down

protectedinherited

Definition at line 133 of file generic_shared_impl.hpp.

                                                   {
#ifdef WITH_EXTRA_CHECKS
    casadi_assert_dev(Function::call_depth_==0);
#endif // WITH_EXTRA_CHECKS
    if (!node) return;
    if (node->weak_ref_) {
#ifdef CASADI_WITH_THREADSAFE_SYMBOLICS
      auto mutex = node->weak_ref_->get_mutex();
      // Avoid triggering a delete while a weak_ref.shared_if_alive is being called
      std::lock_guard<std::mutex> lock(*mutex);
      // Could it be that this mutex is destroyed when the lock goes out of scope?
#endif // CASADI_WITH_THREADSAFE_SYMBOLICS
 
      if (--static_cast<Internal*>(node)->count == 0) {
        delete node;
        node = nullptr;
      }
    } else {
      if (--static_cast<Internal*>(node)->count == 0) {
        delete node;
        node = nullptr;
      }
    }
  }

count_up()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::count_up

protectedinherited

Definition at line 132 of file generic_shared_impl.hpp.

                                                 {
#ifdef WITH_EXTRA_CHECKS
    casadi_assert_dev(Function::call_depth_==0);
#endif // WITH_EXTRA_CHECKS
 
    if (node) static_cast<Internal*>(node)->count++;
 
  }

debug_repr()

std::string casadi::GenericShared< SharedObject , SharedObjectInternal >::debug_repr

inherited

Definition at line 112 of file generic_shared_impl.hpp.

                                                              {
    if (node) {
        return node->debug_repr(node);
    } else {
        return "NULL";
    }
  }

disp()

void casadi::SharedObject::disp ( std::ostream &  stream, bool  more = false  ) const

inherited

Definition at line 35 of file shared_object.cpp.

                                                             {
    if (is_null()) {
      stream << "NULL";
    } else {
      (*this)->disp(stream, more);
    }
  }

References casadi::GenericShared< SharedObject, SharedObjectInternal >::is_null().

Referenced by casadi::Nlpsol::disp_more(), and casadi::CsparseInterface::nfact().

doc()

std::string casadi::XmlFile::doc ( const std::string &  name )

static

Definition at line 60 of file xml_file.cpp.

                                            {
  return XmlFileInternal::getPlugin(name).doc;
}

References casadi::PluginInterface< XmlFileInternal >::getPlugin().

dump()

void casadi::XmlFile::dump	(	const std::string &	filename,
		const XmlNode &	node
	)

Definition at line 52 of file xml_file.cpp.

                                                                 {
  return (*this)->dump(filename, node);
}

References casadi::filename().

Referenced by casadi::DaeBuilderInternal::generate_build_description(), and casadi::DaeBuilderInternal::generate_model_description().

get()

SharedObjectInternal * casadi::GenericShared< SharedObject , SharedObjectInternal >::get

inherited

Definition at line 99 of file generic_shared_impl.hpp.

                                                       {
    return node;
  }

get_str()

std::string casadi::SharedObject::get_str ( bool  more = false ) const

inlineinherited

Definition at line 91 of file shared_object.hpp.

                                               {
        std::stringstream ss;
        disp(ss, more);
        return ss.str();
      }

getCount()

casadi_int casadi::GenericShared< SharedObject , SharedObjectInternal >::getCount

inherited

Definition at line 102 of file generic_shared_impl.hpp.

                                                             {
    return (*this)->getCount();
  }

is_null()

bool casadi::GenericShared< SharedObject , SharedObjectInternal >::is_null

inherited

Definition at line 116 of file generic_shared_impl.hpp.

                                                      {
    return node==nullptr;
  }

load_plugin()

void casadi::XmlFile::load_plugin ( const std::string &  name )

static

Definition at line 56 of file xml_file.cpp.

                                               {
  XmlFileInternal::load_plugin(name);
}

References casadi::PluginInterface< XmlFileInternal >::load_plugin().

operator->() [1/2]

XmlFileInternal * casadi::XmlFile::operator->

(

)

Extra doc: https://github.com/casadi/casadi/wiki/L_7m

Definition at line 44 of file xml_file.cpp.

                                     {
  return static_cast<XmlFileInternal*>(SharedObject::operator->());
}

References casadi::GenericShared< SharedObject, SharedObjectInternal >::operator->().

operator->() [2/2]

const XmlFileInternal * casadi::XmlFile::operator->

(

)

const

Extra doc: https://github.com/casadi/casadi/wiki/L_7n

Definition at line 40 of file xml_file.cpp.

                                                 {
  return static_cast<const XmlFileInternal*>(SharedObject::operator->());
}

References casadi::GenericShared< SharedObject, SharedObjectInternal >::operator->().

own()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::own ( Internal *  node )

inherited

Assign the node to a node class pointer (or null)

Definition at line 89 of file generic_shared_impl.hpp.

                                                           {
    count_down();
    node = node_;
    count_up();
  }

parse()

XmlNode casadi::XmlFile::parse

(

const std::string &

filename

)

Definition at line 48 of file xml_file.cpp.

                                                {
  return (*this)->parse(filename);
}

References casadi::filename().

Referenced by casadi::DaeBuilderInternal::load_fmi_description().

print_ptr()

void casadi::SharedObject::print_ptr ( std::ostream &  stream = casadi::uout() ) const

inherited

Print the pointer to the internal class

Definition at line 43 of file shared_object.cpp.

                                                       {
    stream << get();
  }

References casadi::GenericShared< SharedObject, SharedObjectInternal >::get().

swap()

void casadi::GenericShared< SharedObject , SharedObjectInternal >::swap ( GenericShared< SharedObject, SharedObjectInternal > &  other )

inherited

Definition at line 105 of file generic_shared_impl.hpp.

                                                                 {
    GenericShared<Shared, Internal> temp = *this;
    *this = other;
    other = temp;
  }

type_name()

static std::string casadi::XmlFile::type_name ( )

inlinestatic

Extra doc: https://github.com/casadi/casadi/wiki/L_7l

Definition at line 54 of file xml_file.hpp.

{return "XmlFile";}

weak()

GenericWeakRef< SharedObject , SharedObjectInternal > * casadi::GenericShared< SharedObject , SharedObjectInternal >::weak

inherited

Extra doc: https://github.com/casadi/casadi/wiki/L_aw

Definition at line 130 of file generic_shared_impl.hpp.

                                                                          {
    return (*this)->weak();
  }

---

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

• xml_file.hpp
• xml_file.cpp