sdRelationshipAssociationType Class Reference


Public Methods

 sdRelationshipAssociationType (sdRelationshipAssociationTypeEnum valueType)
 sdRelationshipAssociationType (const std::string &name)
 ~sdRelationshipAssociationType ()
 operator sdRelationshipAssociationTypeEnum () const
const std::string & getName () const

Detailed Description

The sdRelationshipAssociationType class encapsulates enumerated sdRelationshipAssociationTypeEnum values that specify the association type of the relationship. For example, a relationship might exist between two peers, or between an owning object and owned object.

See Enum Wrappers in the Programmers Guide for a discussion of enum wrappers.

enum sdRelationshipAssociationTypeEnum
 

Enumeration values:
sdcOwnedRelationshipAssociationType  "Owned"
sdcOwnerRelationshipAssociationType  "Owner"
sdcPeerRelationshipAssociationType  "Peer"

Constructor & Destructor Documentation

sdRelationshipAssociationType::sdRelationshipAssociationType (  sdRelationshipAssociationTypeEnum    valueType )  [inline]
 

This function constructs an instance of an sdRelationshipAssociationType object using the specified sdRelationshipAssociationTypeEnum value.

Parameters:
valueType An sdRelationshipAssociationTypeEnum value that specifies the association type of the relationship.

sdRelationshipAssociationType::sdRelationshipAssociationType (  const std::string &    name ) 
 

This function constructs an instance of an sdRelationshipAssociationType object using the sdRelationshipAssociationTypeEnum associated with the specified string name. This name must be defined in the legal set of names associated with sdRelationshipAssociationTypeEnum.

Parameters:
name The name of an sdRelationshipAssociationTypeEnum value.
Exceptions:
sdcInvalidRelationshipAssociationTypeName 

sdRelationshipAssociationType::~sdRelationshipAssociationType (    )  [inline]
 

This is the sdRelationshipAssociationType destructor.

Member Function Documentation

const std::string & sdRelationshipAssociationType::getName (    )  const
 

This function retrieves the name of this sdRelationshipAssociationType object.

sdRelationshipAssociationType::operator sdRelationshipAssociationTypeEnum (    )  const [inline]
 

This operator casts this sdRelationshipAssociationType into its corresponding sdRelationshipAssociationTypeEnum value.

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.