sdRelationshipOrderingType Class Reference


Public Methods

 sdRelationshipOrderingType (sdRelationshipOrderingTypeEnum valueType)
 sdRelationshipOrderingType (const std::string &name)
 ~sdRelationshipOrderingType ()
 operator sdRelationshipOrderingTypeEnum () const
const std::string & getName () const

Detailed Description

The sdRelationshipOrderingType class encapsulates enumerated sdRelationshipOrderingTypeEnum values that define the ordering of the objects that can be returned.

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

enum sdRelationshipOrderingTypeEnum
 

Enumeration values:
sdcUnorderedRelationshipOrderingType  "Unordered"
sdcStrictlyOrderedRelationshipOrderingType  "StrictlyOrdered"
sdcOptionallyOrderedRelationshipOrderingType  "OptionallyOrdered"

Constructor & Destructor Documentation

sdRelationshipOrderingType::sdRelationshipOrderingType (  sdRelationshipOrderingTypeEnum    valueType )  [inline]
 

This sdRelationshipOrderingType constructor takes an sdRelationshipOrderingTypeEnum value as an argument.

Parameters:
valueType An sdRelationshipOrderingTypeEnum value.

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

This sdRelationshipOrderingType constructor takes a string name as an argument.

Parameters:
name The string name for the sdRelationshipOrderingType.
Exceptions:
sdcInvalidRelationshipOrderingTypeName 

sdRelationshipOrderingType::~sdRelationshipOrderingType (    )  [inline]
 

This is the sdRelationshipOrderingType destructor.

Member Function Documentation

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

This function returns the name of this sdRelationshipOrderingType object.

sdRelationshipOrderingType::operator sdRelationshipOrderingTypeEnum (    )  const [inline]
 

This operator casts this sdRelationshipOrderingType object into its sdRelationshipOrderingTypeEnum 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.