sdRelationshipContainerType Class Reference


Public Methods

 sdRelationshipContainerType (sdRelationshipContainerTypeEnum container)
 sdRelationshipContainerType (const std::string &name)
 ~sdRelationshipContainerType ()
 operator sdRelationshipContainerTypeEnum () const
const std::string & getName () const

Detailed Description

The sdRelationshipContainerType class encapsulates enumerated sdRelationshipContainerTypeEnum values that define how the related objects can be returned.

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

enum sdRelationshipContainerTypeEnum
 

Enumeration values:
sdcSingleRelationshipContainerType  "Single"
sdcArrayRelationshipContainerType  "Array"
sdcCollectionRelationshipContainerType  "Collection"
sdc2DTableRelationshipContainerType 

Constructor & Destructor Documentation

sdRelationshipContainerType::sdRelationshipContainerType (  sdRelationshipContainerTypeEnum    container )  [inline]
 

This function constructs an instance of an sdRelationshipContainerType object using the specified sdRelationshipContainerTypeEnum value.

Parameters:
container An sdRelationshipContainerTypeEnum value that defines how the related objects can be returned.

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

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

Parameters:
name The name of an sdRelationshipContainerTypeEnum.
Exceptions:
sdcInvalidRelationshipContainerTypeName 

sdRelationshipContainerType::~sdRelationshipContainerType (    )  [inline]
 

This is the sdRelationshipContainerType destructor.

Member Function Documentation

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

This function returns the name string associated with the encapsulated sdRelationshipContainerTypeEnum value.

sdRelationshipContainerType::operator sdRelationshipContainerTypeEnum (    )  const [inline]
 

This operator casts this sdRelationshipContainerType into its corresponding sdRelationshipContainerTypeEnum 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.