sdAttribute Class Reference

Inheritance diagram for sdAttribute:

sdBase


Public Methods

 sdAttribute (unsigned int id, const std::string &name, const std::string &description, const Actions &actions, sdAttributeContainerType containerType, bool isObjectIdentifier, sdNameSpace *nameSpace, const sdObject *object, const sdValue *value)
virtual ~sdAttribute ()
unsigned int getId () const
const std::string & getName () const
const std::string & getDescription () const
const sdObject * getObject () const
const sdValue * getValue () const
ActionConstIter begin () const
ActionConstIter end () const
sdAttributeContainerType getContainerType () const
virtual void accept (sdVisitor *visitor)

Public Types

typedef std::vector< sdAttributeActionType > Actions
typedef Actions::const_iterator ActionConstIter

Detailed Description

The sdAttribute class defines an attribute of a class in a schema definition. An sdAttribute is associated with:

Member Typedef Documentation

typedef Actions::const_iterator sdAttribute::ActionConstIter
 

typedef std::vector<sdAttributeActionType> sdAttribute::Actions
 

Constructor & Destructor Documentation

sdAttribute::sdAttribute (  unsigned int    id,
const std::string &    name,
const std::string &    description,
const Actions &    actions,
sdAttributeContainerType    containerType,
bool    isObjectIdentifier,
sdNameSpace *    nameSpace,
const sdObject *    object,
const sdValue *    value
) 
 

This is the sdAttribute constructor.

Parameters:
id The ID for the attribute.
name The name for the attribute.
description The description for the attribute.
actions An sdAttributeActionTypeEnum that defines the various actions that can be performed on an attribute (such as get or set).
containerType An sdAttributeContainerTypeEnum that defines how the attribute can be returned (as a single item or collection, for example).
isObjectIdentifier A boolean that indicates whether or not this attribue is the single attribute that can be used to find the object. For example, the name of an oaInst is such an identifier.
nameSpace The namespace for the sdAttribute.
object The schema definition object for this sdAttribute.
value The schema definition value for this sdAttribute.
Exceptions:
sdcObjectAttributeInDifferentNamespaces 

sdAttribute::~sdAttribute (    )  [virtual]
 

This is the sdAttribute destructor.

Member Function Documentation

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

This function calls the visit function of the specified visitor on the attribute.

Parameters:
visitor A pointer to the visitor.

Implements sdBase.

ActionConstIter sdAttribute::begin (    )  const
 

This function returns a constant iterator that points to the first action in the set of actions allowed on this attribute.

ActionConstIter sdAttribute::end (    )  const
 

This function returns a constant iterator that points to the last action in the set of actions allowed on this attribute.

sdAttributeContainerType sdAttribute::getContainerType (    )  const
 

This function returns the type of container (such as single item, array, or collection) of this schema attribute object.

const std::string & sdAttribute::getDescription (    )  const
 

This function returns the description of this schema attribute object.

oa::oaUInt4 sdAttribute::getId (    )  const
 

This function returns the ID data of this schema attribute object.

const std::string * sdAttribute::getName (    )  const
 

This function returns the name data of this schema attribute object.

const sdObject * sdAttribute::getObject (    )  const
 

This function return the sdObject associated with this schema attribute object.

const sdValue * sdAttribute::getValue (    )  const
 

This function returns the value of this schema attribute object.

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.