objects/
mg_container__define.pro
includes main-level programSubclass of IDL_Container that also has a getByName method.
Class description for mg_container
Inheritance
- IDL_CONTAINER
Properties
Properties in mg_container
- _extra set init
properties of IDL_Container
- _ref_extra get
properties of IDL_Container
- name get set
name of the container to be used by the getByName method
Fields
Fields in IDL_CONTAINER
- IDLCONTAINERVERSION 0S
- IDL_CONTAINER_BOTTOM 0LL
- IDL_CONTAINER_TOP 0LL
- NLIST 0L
- PHEAD ptr_new()
- PTAIL ptr_new()
Fields in mg_container
- name ''
name of object to be used in getByName method
Routines
Routines from mg_container__define.pro
result = mg_container::_askName(obj)
Finds the name of an object, even if it does not have a NAME property.
result = mg_container::_getChildByName(name, container)
Returns an immediate child of a container by name.
result = mg_container::getByName(name)
Traverses a hierarchy of named objects using a path of names delimited with /'s.
mg_container::getProperty, name=name, _ref_extra=_ref_extra
Get properties.
mg_container::setProperty, name=name, _extra=_extra
Set properties.
mg_container::cleanup
Free resources of the object.
result = mg_container::init( [_extra=keywords])
Create an MG_Container object.
mg_container__define
Define instance variables and inheritance.
Routine details
top source mg_container::_askName
result = mg_container::_askName(obj)
Finds the name of an object, even if it does not have a NAME property. Returns the empty string if the object does not have a NAME property.
Return value
string
Parameters
- obj in required type=object
object to find name of
top source mg_container::_getChildByName
result = mg_container::_getChildByName(name, container)
Returns an immediate child of a container by name.
Return value
object
Parameters
- name in required type=string
name of immediate child
- container in required type=object
container to search children of
top source mg_container::getByName
result = mg_container::getByName(name)
Traverses a hierarchy of named objects using a path of names delimited with /'s.
Return value
object
Parameters
- name in required type=string
path of names to the desired object; names are delimited with /'s
top source mg_container::getProperty
mg_container::getProperty, name=name, _ref_extra=_ref_extra
Get properties.
Keywords
- name
name of the container to be used by the getByName method
- _ref_extra
properties of IDL_Container
top source mg_container::setProperty
mg_container::setProperty, name=name, _extra=_extra
Set properties.
Keywords
- name
name of the container to be used by the getByName method
- _extra
properties of IDL_Container
File attributes
Modification date: | Sat Jan 31 21:15:45 2015 |
Lines: | 67 |
Docformat: | rst rst |