sdRelationshipActionType Class Reference


Public Methods

 sdRelationshipActionType (sdRelationshipActionTypeEnum valueType)
 sdRelationshipActionType (const std::string &name)
 ~sdRelationshipActionType ()
 operator sdRelationshipActionTypeEnum () const
const std::string & getName () const

Detailed Description

The sdRelationshipActionType class encapsulates enumerated sdRelationshipActionTypeEnum values that define the various actions that can be performed on a relationship. For example, a relationship can be created or destroyed.

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

enum sdRelationshipActionTypeEnum
 

Enumeration values:
sdcGetRelationshipActionType  "Get"
sdcCreateRelationshipActionType  "Create"
sdcDestroyRelationshipActionType  "Destroy"
sdcInitRelationshipActionType  "Init"

Constructor & Destructor Documentation

sdRelationshipActionType::sdRelationshipActionType (  sdRelationshipActionTypeEnum    valueType )  [inline]
 

This function constructs an instance of an sdRelationshipActionType object using the specified sdRelationshipActionTypeEnum value.

Parameters:
valueType An sdRelationshipActionTypeEnum.

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

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

Parameters:
name The name associated with an sdRelationshipActionType value.
Exceptions:
sdcInvalidRelationshipActionTypeName 

sdRelationshipActionType::~sdRelationshipActionType (    )  [inline]
 

This is the sdRelationshipActionType destructor.

Member Function Documentation

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

This function returns the name of this sdRelationshipActionType object.

sdRelationshipActionType::operator sdRelationshipActionTypeEnum (    )  const [inline]
 

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