sdRelationshipSet Class Reference

Inheritance diagram for sdRelationshipSet:

sdRelationshipBase sdBase


Public Methods

 sdRelationshipSet (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 ObjectVector &toObjects)
virtual ~sdRelationshipSet ()
const sdObject * getFrom () const
ObjectConstIter beginToObject () const
ObjectConstIter endToObject () const
virtual void accept (sdVisitor *visitor)

Public Types

typedef std::vector< const sdObject * > ObjectVector
typedef ObjectVector::const_iterator ObjectConstIter

Detailed Description

The sdRelationshipSet class is the schema class for describing a relationship that involves a single 'from' class and multiple 'to' classes. The 'to' set of classes is a list of valid classes that can have this relationship.

For example, the relationship on the beginning connection of an oaRoute can be one of oaTerm, oaInstTerm, oaSteiner, oaPin, oaShape, or oaVia.

Member Typedef Documentation

typedef ObjectVector::const_iterator sdRelationshipSet::ObjectConstIter
 

typedef std::vector<const sdObject*> sdRelationshipSet::ObjectVector
 

Constructor & Destructor Documentation

sdRelationshipSet::sdRelationshipSet (  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 ObjectVector &    toObjects
) 
 

This is the sdRelationshipSet constructor.

Parameters:
id The ID number for the sdRelationshipSet.
name The name for the sdRelationshipSet.
relDescription The description for the sdRelationshipSet
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 sdRelationshipSet.
from The originating (from) object in the sdRelationshipSet.
toObjects The set of valid objects that can be the 'to' object in this sdRelationshipSet.
Exceptions:
sdcObjectRelationshipInDifferentNamespaces 

sdRelationshipSet::~sdRelationshipSet (    )  [virtual]
 

This is the sdRelationshipSet destructor.

Member Function Documentation

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

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

Parameters:
visitor A pointer to the visitor to call.

Implements sdBase.

ObjectConstIter sdRelationshipSet::beginToObject (    )  const
 

This function returns a constant iterator that points to the first 'to' object in the sdRelationshipSet.

ObjectConstIter sdRelationshipSet::endToObject (    )  const
 

This function returns a constant iterator that points to the last 'to' object in this sdRelationshipSet.

const sdObject * sdRelationshipSet::getFrom (    )  const
 

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

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.