Data Model version 2.0.6
Acknowledgements
Diagram | Class Map | Attribute Map | Method Map | Help | License
Home | Package | Class: { prev | next } | Attribute | Method

Class: MemopsObject


Abstract Class

    Base class for Memops data model classes.
    Contains elements common to all classes, e.g. the link to ApplicationData, and the root and parent links.
Attributes
Link Attributes
Attribute Methods
Link Attribute Methods
Class Methods
Factory Methods
Other Methods
Appendix

Inheritance:


Details:

Parent: None
Main key: n/a
Mandatory Attributes: None
Known Subclasses: DataObject, ImplementationObject
Children: None

Attributes

Go to Top
Attribute Type Multiplicity Description
isDeleted Boolean 1..1 Implementation attribute, set automatically. If True the object has been deleted. Deleted objects are never returned by any API call, so there is normally no need to check this attribute. But if you keep your own lists (or other data structures) containing CCP objects, you may need to look.  

Inherited Attributes: classNamefieldNamesinConstructormetaclasspackageNamepackageShortNamequalifiedName

Link Attributes

Go to Top
Attribute Type Multiplicity Description
root MemopsRoot 1..1 MemopsRoot object at top of parent tree.  

Inherited Attributes: None

Attribute Methods (in class)

Go to Top
Attribute Method Return Parameters Comment
isDeleted
getIsDeleted Boolean -

Link Attribute Methods (in class)

Go to Top
Attribute Method Return Parameters Comment
root
getRoot MemopsRoot -

Class Methods (in class)

Go to Top
Method Return Parameters Comment
None

Factory Methods (in class)

Go to Top
Method Return Parameters
None

Other Methods (in class)

Go to Top
Method Return Parameters Comment
getByNavigation Any Any Set Return object or element given a navigation sequence, or None if none found
    
Intended to provide fast, one-function-call access to
long range navigation, mainly for UML-embedded code.
NB there is no error checking on the input.
The function may fail without proper warning for incorrect input.
Also the function bypasses the API on get commands, so that load is
not triggered on MemopsRoot->TopObject links or partially filled
interpackage crosslinks
Programmer beware!

Navigation starts at self and follows the navigation sequence,
which consists of either string tags, or (tag,key) tuples.
- For a string tag the function gets the corresponding element.
Except at the end of the navigation sequence, this assumes that
the element has hicard==1, and is a link or complex data type attribute.
If the result evaluates false, a getattr is done instead.
This may trigger loading and follow derived links.
- For a (tag,key) tuple this assumes that the tag is the name of a
child link, and gets the child with the given key.
If no children are found and the object has an attribute isLoaded==False,
object.load() is tried.
- If at any stage in the lookup no object is found, None is returned
    
getExpandedKey Any List - non-std. get expanded (object-free) version of full key, for comparing objects from different trees.

Appendix

Go to Top

guid:

www.ccpn.ac.uk_Fogh_2006-08-16-14:22:53_00027

isImplicit:

False

Tag

Value
repositoryId $Id: MemopsObject.xml,v 1.62 2011-01-13 14:40:37 rhfogh Exp $

Tag

Value
repositoryTag $Name: not supported by cvs2svn $

Special constructor code:

None

Special destructor code:

None

Constraints:

None
Known inward one-way links: None
  Data Model Version 2.0.6
Go to Top  
  Autogenerated by  PyApiDocGen  revision 1.3   on  Wed Aug 7 15:06:13 2013    from data model package  memops.api.Implementation.MemopsObject   revision 1.62  
  Work done by the CCPN team.
www.ccpn.ac.uk