urdf_parser_py.xml_reflection.core.Object Class Reference

Inheritance diagram for urdf_parser_py.xml_reflection.core.Object:

Public Member Functions
def	add_aggregate (self, xml_var, obj)
def	add_aggregates_to_xml (self, node)
def	aggregate_init (self)
def	check_valid (self)
def	from_xml (cls, node, path)
def	from_xml_file (cls, file_path)
def	from_xml_string (cls, xml_string)
def	get_aggregate_list (self, xml_var)
def	get_refl_vars (self)
def	lump_aggregates (self)
def	parse (self, xml_string)
def	post_read_xml (self)
def	pre_write_xml (self)
def	read_xml (self, node, path)
def	remove_aggregate (self, obj)
def	to_xml (self)
def	to_xml_string (self, addHeader=True)
def	write_xml (self, node)
Public Member Functions inherited from urdf_parser_py.xml_reflection.basics.YamlReflection
def	__str__ (self)
def	to_yaml (self)
Public Member Functions inherited from urdf_parser_py.xml_reflection.basics.SelectiveReflection
def	get_refl_vars (self)

Public Attributes
	aggregate_order
	aggregate_type

Static Public Attributes
	XML_REFL

Detailed Description

Raw python object for yaml / xml representation 

Definition at line 562 of file core.py.

Member Function Documentation

add_aggregate()

def urdf_parser_py.xml_reflection.core.Object.add_aggregate	(		self,
			xml_var,
			obj
	)

NOTE: One must keep careful track of aggregate types for this system.
Can use 'lump_aggregates()' before writing if you don't care. 

Definition at line 638 of file core.py.

add_aggregates_to_xml()

def urdf_parser_py.xml_reflection.core.Object.add_aggregates_to_xml	(		self,
			node
	)

Definition at line 645 of file core.py.

aggregate_init()

def urdf_parser_py.xml_reflection.core.Object.aggregate_init

(

self

)

Must be called in constructor! 

Definition at line 632 of file core.py.

check_valid()

def urdf_parser_py.xml_reflection.core.Object.check_valid

(

self

)

Definition at line 569 of file core.py.

from_xml()

def urdf_parser_py.xml_reflection.core.Object.from_xml	(		cls,
			node,
			path
	)

Definition at line 608 of file core.py.

from_xml_file()

def urdf_parser_py.xml_reflection.core.Object.from_xml_file	(		cls,
			file_path
	)

Definition at line 619 of file core.py.

from_xml_string()

def urdf_parser_py.xml_reflection.core.Object.from_xml_string	(		cls,
			xml_string
	)

Definition at line 613 of file core.py.

get_aggregate_list()

def urdf_parser_py.xml_reflection.core.Object.get_aggregate_list	(		self,
			xml_var
	)

Definition at line 626 of file core.py.

get_refl_vars()

def urdf_parser_py.xml_reflection.core.Object.get_refl_vars

(

self

)

Definition at line 566 of file core.py.

lump_aggregates()

def urdf_parser_py.xml_reflection.core.Object.lump_aggregates

(

self

)

Put all aggregate types together, just because 

Definition at line 657 of file core.py.

parse()

def urdf_parser_py.xml_reflection.core.Object.parse	(		self,
			xml_string
	)

Definition at line 666 of file core.py.

post_read_xml()

def urdf_parser_py.xml_reflection.core.Object.post_read_xml

(

self

)

Definition at line 594 of file core.py.

pre_write_xml()

def urdf_parser_py.xml_reflection.core.Object.pre_write_xml

(

self

)

If anything needs to be converted prior to dumping to xml
i.e., getting the names of objects and such 

Definition at line 572 of file core.py.

read_xml()

def urdf_parser_py.xml_reflection.core.Object.read_xml	(		self,
			node,
			path
	)

Definition at line 597 of file core.py.

remove_aggregate()

def urdf_parser_py.xml_reflection.core.Object.remove_aggregate	(		self,
			obj
	)

Definition at line 651 of file core.py.

to_xml()

def urdf_parser_py.xml_reflection.core.Object.to_xml

(

self

)

Creates an overarching tag and adds its contents to the node 

Definition at line 583 of file core.py.

to_xml_string()

def urdf_parser_py.xml_reflection.core.Object.to_xml_string	(		self,
			addHeader = True
	)

Definition at line 591 of file core.py.

write_xml()

def urdf_parser_py.xml_reflection.core.Object.write_xml	(		self,
			node
	)

Adds contents directly to XML node 

Definition at line 577 of file core.py.

Member Data Documentation

aggregate_order

urdf_parser_py.xml_reflection.core.Object.aggregate_order

Definition at line 634 of file core.py.

aggregate_type

urdf_parser_py.xml_reflection.core.Object.aggregate_type

Definition at line 636 of file core.py.

XML_REFL

urdf_parser_py.xml_reflection.core.Object.XML_REFL

static

Definition at line 564 of file core.py.

---

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

• core.py