sdRelationship Class Reference

Inheritance diagram for sdRelationship:

sdRelationshipBase sdBase


Public Methods

 sdRelationship (unsigned int id, const std::string &name, const std::string &relDescription, sdRelationshipOrderingType orderType, const Actions &actions, sdRelationshipAssociationType associationType, sdRelationshipMultiplicityType multiplicityType, sdRelationshipContainerType containerType, sdNameSpace *nameSpace, const sdObject *from, const sdObject *to)
virtual ~sdRelationship ()
const sdObject * getFrom () const
const sdObject * getTo () const
virtual void accept (sdVisitor *visitor)

Detailed Description

The sdRelationship class provides the schema definition of a relationship between two classes.

Constructor & Destructor Documentation

sdRelationship::sdRelationship (  unsigned int    id,
const std::string &    name,
const std::string &    relDescription,
sdRelationshipOrderingType    orderType,
const Actions &    actions,
sdRelationshipAssociationType    associationType,
sdRelationshipMultiplicityType    multiplicityType,
sdRelationshipContainerType    containerType,
sdNameSpace *    nameSpace,
const sdObject *    from,
const sdObject *    to
) 
 

This is the sdRelationship constructor.

Parameters:
id The ID number for the sdRelationship.
name The name for the sdRelationship.
relDescription The description for the sdRelationship.
orderType The type of ordering for the 'to' objects that would be returned on this relationship. For example, the ordering might be unordered or strictly ordered.
actions The actions that can be performed on this relationship.
associationType The association type of this relationship. For example, a relationship might exist between two peers, or between an owning object and owned object.
multiplicityType The multiplicity type of this relationship. For example, a relationship might be a one-to-one relationship, or a one-to-many relationship.
containerType The type of container for the 'to' objects that would be returned on this relationship. For example, as a collection, an array, or a single object.
nameSpace The namespace for the sdRelationship.
from The originating (from) object in the sdRelationship.
to The ending (to) object in the sdRelationship.
Exceptions:
sdcObjectRelationshipInDifferentNamespaces 

sdRelationship::~sdRelationship (    )  [virtual]
 

This is the sdRelationship destructor.

Member Function Documentation

void sdRelationship::accept (  sdVisitor *    visitor )  [virtual]
 

This function calls the visit function of the specified visitor on the relationship.

Parameters:
visitor A pointer to the visitor to call.

Implements sdBase.

const sdObject * sdRelationship::getFrom (    )  const
 

This function returns the 'from' object of this relationship.

const sdObject * sdRelationship::getTo (    )  const
 

This function returns the 'to' object of this relationship.

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

Return to top of page




Copyright © 2002 - 2010 Cadence Design Systems, Inc.
All Rights Reserved.