![]() |
![]() |
![]() |
![]() |
![]() |
Reference
The reference contains two parts:
- Data Model: information about the data model used. For each class, a description is provided and then the members of the class are presented in a table.
- Functions: information about the functions in OM Access. For each function, the definition is shown followed by a description and a table of the parameters.
Data Model
The data model in OM Access is based on the UML Metamodel. For more information about the UML Metamodel, see the "UML Semantics" chapter of the "Unified Modeling Language, version 1.1" documentation. This document can be found at:
http://www-306.ibm.com/software/rational/uml/If not mentioned otherwise, the members are of type string.
OMModule
An instance of the OMModule class contains information about an OM Diagram.
classList generalizationListA list of Generalization, containing all of the generalizations.
associationListA list of AssocationClass, containing all of the associations/aggregations.
Class
An instance of the Class class contains information about a class.
name attributeListA list of Attribute, each entry representing one attribute in the class.
operationListA list of Operation, each entry representing one attribute in the class.
Operation
An instance of the Operation class contains information about an operation.
visibility name returnType parameterListList of Parameter containing information about the operations parameters.
Parameter
An instance of the Parameter class contains information about a parameter.
Attribute
An instance of the Attribute class contains information about an attribute.
Generalization
An instance of the Generalization class contains information about a generalization.
subtype supertypeThe name of the supertype, `superclass' of the generalization.
discriminatorAssociationClass
An instance of the AssociationClass class contains information about an association/aggregation. The connection between the different classes is maintained by fromEnd and toEnd.
If the association also has an associationclass, the class-information is contained in the instance, inherited from Class.
AssociationEnd
An instance of the AssociationEnd class contains information about a connection to a class, for example in an association.
name rolename type multiplicity qualifier constraint aggregation isSorted isOrderedFunctions
GetFile
bool GetFile(filename, omModule, status)Description
Loads the contents of filename into omModule.Returns true on success, false if failed to load the module.
Parameters
filename string omModule OMModule *A pointer to the OMModule where the diagrams data will be put.
status string *(optional) If loading failed a diagnostic message is inserted into this string.
GetBufID
bool GetBufID(bufID,omModule,status)Description
Loads the contents of the buffer bufID into omModule. Returns true on success, false if failed to load the module.
Parameters
bufID string omModule OMModule *A pointer to the OMModule where the diagrams data will be put.
status string *(optional) If loading failed a diagnostic message is inserted into this string.
GetSuperClassList
GetSuperClassList(omModule,className,superClasses)Description
Fills the list superClasses with the names of the superclasses to className in omModule.
Parameters
omModule OMModule & className string superClasses list<string> *GetSubClassList
GetSubClassList(omModule,className,superClasses)Description
Fills the list subClasses with the names of the subclasses to className in omModule.
Parameters
omModule OMModule & className string subClasses list<string> *SourceAggregationEnd
string SourceAggregationEnd(association)Description
Returns the name of the class which starts the aggregation (the end with the square in it), the owner-part. (The source contains the end.)
Parameters
TargetAggregationEnd
string TargetAggregationEnd(association)Description
Returns the name of the class that ends the aggregation (the end without the square in it), the owned-part. (The source contains the end.)
Parameters
GetEndPoints
void GetEndPoints(association, classes)Description
Fills the classes list with the names of the classes that this association/aggregation is connected to.
Parameters
association AssociationClass classes list<string> *HasEndpoint
bool hasEndPoint(association, name)Description
Returns true if association has an endpoint at name.
Parameters
association AssociationClass name stringGetAggregations
void GetAggregations(omModule,aggregations)Description
Fills aggregations with all the aggregations in omModule.
Parameters
omModule OMModule aggregations list<Associ ationClass>GetAggregations
void GetAggregations(comModule,aggregations,owner)Description
Fills aggregations with all the aggregations in omModule, that has owner as source.
Parameters
omModule OMModule aggregations list<AssociationClass> owner stringGetAssociations
void GetAssociations(omModule, associations)Description
Fills associations with all the associations in omModule.
Parameters
omModule OMModule associations list<AssociationClass>GetAssociations
void GetAssociations(omModule, associations,firstEnd)Description
Fills associations with all the associations in omModule, that is connected to firstEnd, in some end.
Parameters
omModule OMModule associations list<AssociationClass> firstEnd stringThe name of one of the classes that the association has to be connected to.
GetAssociations
void GetAssociations(omModule,associations,firstEnd,secondEnd)Description
Fills associations with all the associations in omModule, that is connected to firstEnd, and secondEnd.
Parameters
TraceModule
void TraceModule(omModule,os)Description
Outputs a textual dump of omModule to os, with as much information as possible, useful for debugging purposes.
Parameters
http://www.ibm.com/rational |
![]() |
![]() |
![]() |
![]() |