XDF::BaseObject

Section: User Contributed Perl Documentation (3)
Updated: perl v5.6.0
 

Index

NAME
SYNOPSIS
DESCRIPTION
METHODS
CLASS Methods
INSTANCE (Object) Methods
INHERITED Class Methods
INHERITED INSTANCE Methods
SEE ALSO
AUTHOR
This document was created by man2html.
Time: 23:21:07 GMT, March 28, 2002
 

NAME

XDF::BaseObject - Perl Class for BaseObject  

SYNOPSIS

...
 

DESCRIPTION

XDF is the eXtensible Data Structure, which is an XML format designed to contain n-dimensional scientific/mathematical data. XDF::BaseObject is the base class that all other XDF object classes inherit from. It supplies general use methods to these sub classes. (Diagram of object structure??) Most other XDF objects inherit the methods of XDF::BaseObject.XDF::BaseObject inherits class and attribute methods of XDF::GenericObject .  

METHODS

 

CLASS Methods

The following methods are defined for the class XDF::BaseObject.


getClassAttributes (EMPTY)
This method returns a list reference containing the namesof the class attributes for this object;This method takes no arguments may not be changed.

getClassXMLAttributes (EMPTY)
Return a list ref of the XML attributes for this class.
 

INSTANCE (Object) Methods

The following instance (object) methods are defined for XDF::BaseObject.


getXMLAttributes (EMPTY)
Return a list reference of the XML attributes held by this object. This list *may* differ from that returned by getClassXMLAttributesas new, user-defined Attributes may have been added to this instance.

setXMLAttributes ($attribHashRef)
Set the XML attributes of this object using a passed Hashtable ref.

setXMLAttribute ($attrib, $value)


addXMLAttribute ($attrib, $value)


addToGroup ($groupObj)
Add this object as a member of a group. Returns : 1 on success, 0 on failure.

removeFromGroup ($groupObj)
Remove this object from membership in a group.

isGroupMember ($groupObj)
Determine if this object is a member of the reference Group object. Returns 1 if true, undef if false.

toXMLFileHandle ($fileHandle, $XMLDeclAttribs, $indent, $dontCloseNode, $newNodeNameString, $noChildObjectNodeName)
Write this structure and all the objects it owns to the supplied filehandle in XML (XDF) format. The first argument is the name of the filehandle and is required.

toXMLString ($XMLDeclAttribs, $indent, $dontCloseNode, $newNodeNameString, $noChildObjectNodeName)
Print out the XML representation of this object. Similar to toXMLFileHandle method, takes the same arguments barring thefirst (e.g. the FileHandle reference) which is not needed for this method. Returns a string XML representation of the object.

toXMLFile ($file, $XMLDeclAttribs)
This is a convenience method which allows writing of this object and all the objects it owns to the indicated file in XML (XDF) format. The first argument is the name of the file and is required. The supplied filename will be OVERWRITTEN, not appended to. The second, optional, argument has the same meaning as for toXMLFileHandle.
 

INHERITED Class Methods

 

INHERITED INSTANCE Methods

XDF::BaseObject inherits the following instance (object) methods of XDF::GenericObject : new, clone, update.
 

SEE ALSO

XDF::Array, XDF::Axis, XDF::DataCube, XDF::FieldAxis, XDF::GenericObject, XDF::Specification  

AUTHOR

    Brian Thomas  (thomas@adc.gsfc.nasa.gov)
    Astronomical Data Center <http://adc.gsfc.nasa.gov>
    NASA/Goddard Space Flight Center

Index