srObjectState Class Reference

Inheritance diagram for srObjectState:

srBase


Public Methods

 srObjectState (const sd::sdObject *def, const AttributeMap &attributes, const RelationshipMap &relationships)
virtual ~srObjectState ()
virtual void accept (srVisitorMgr &visitor)
const sd::sdObject * getDef () const
AttributeConstIter beginAttribute () const
AttributeConstIter endAttribute () const
RelationshipConstIter beginRelationship () const
RelationshipConstIter endRelationship () const
void addAttribute (srAttributeBase::SPtr attribute, bool overwrite=false)
void addRelationship (srRelationshipBase::SPtr relationship, bool overwrite=false)
void setAttributes (const AttributeMap &attributes)
void setRelationships (const RelationshipMap &relationships)

Public Types

typedef srObjectState * SPtr
typedef std::map< const sd::sdAttribute *, srAttributeBase::SPtr, srSDEnumLess< sd::sdAttribute > > AttributeMap
typedef std::map< const sd::sdRelationshipBase *, srRelationshipBase::SPtr, srSDEnumLess< sd::sdRelationshipBase > > RelationshipMap
typedef std::pair< const sd::sdAttribute *, srAttributeBase::SPtr > AttributePair
typedef std::pair< const sd::sdRelationshipBase *, srRelationshipBase::SPtr > RelationshipPair
typedef AttributeMap::const_iterator AttributeConstIter
typedef RelationshipMap::const_iterator RelationshipConstIter

Detailed Description

The srObjectState class contains the full state of a specific object defined in the schema definition, including all the attributes and relationships of the object.

Member Typedef Documentation

typedef AttributeMap::const_iterator srObjectState::AttributeConstIter
 

typedef std::map<const sd::sdAttribute*, srAttributeBase::SPtr, srSDEnumLess<sd::sdAttribute> > srObjectState::AttributeMap
 

typedef std::pair<const sd::sdAttribute*, srAttributeBase::SPtr> srObjectState::AttributePair
 

typedef RelationshipMap::const_iterator srObjectState::RelationshipConstIter
 

typedef std::map<const sd::sdRelationshipBase*, srRelationshipBase::SPtr, srSDEnumLess<sd::sdRelationshipBase> > srObjectState::RelationshipMap
 

typedef std::pair<const sd::sdRelationshipBase*, srRelationshipBase::SPtr> srObjectState::RelationshipPair
 

typedef srObjectState* srObjectState::SPtr
 

Reimplemented from srBase.

Constructor & Destructor Documentation

srObjectState::srObjectState (  const sd::sdObject *    def,
const AttributeMap &    attributes,
const RelationshipMap &    relationships
) 
 

This is the srObjectState constructor.

Parameters:
def Pointer to the schema definition for the object.
attributes The attributes of the object.
relationships The relationships of the object

srObjectState::~srObjectState (    )  [virtual]
 

This is the srObjectState destructor.

Member Function Documentation

void srObjectState::accept (  srVisitorMgr &    visitor )  [virtual]
 

This function is responsible for calling the correct visitor.

Parameters:
visitor The visitor to call.

Implements srBase.

void srObjectState::addAttribute (  srAttributeBase::SPtr    attribute,
bool    overwrite = false
) 
 

This function adds an attribute to the object state.

Parameters:
attribute The attribute to add to the object state.
overwrite Boolean flag that indicates whether or not to overwrite the attribute if it already exists in the object state.

void srObjectState::addRelationship (  srRelationshipBase::SPtr    relationship,
bool    overwrite = false
) 
 

This function adds a relationship to the object state.

Parameters:
relationship The relationship to add to the object state.
overwrite Boolean flag that indicates whether or not to overwrite the relationship if it already exists in the object state.

AttributeConstIter srObjectState::beginAttribute (    )  const
 

This function returns a constant iterator pointing to the first attribute in the collection.

RelationshipConstIter srObjectState::beginRelationship (    )  const
 

This function returns a constant iterator pointing to the first relationship in the collection.

AttributeConstIter srObjectState::endAttribute (    )  const
 

This function returns a constant iterator pointing to the last attribute in the collection.

RelationshipConstIter srObjectState::endRelationship (    )  const
 

This function returns a constant iterator pointing to the last relationship in the collection.

const sd::sdObject * srObjectState::getDef (    )  const
 

This function is the accessor to get the schema definition object.

void srObjectState::setAttributes (  const AttributeMap &    attributes ) 
 

This function sets the attributes of the object state.

Parameters:
attributes The attributes to set for the object state.

void srObjectState::setRelationships (  const RelationshipMap &    relationships ) 
 

This function sets the relationships of the object state.

Parameters:
relationships The relationships to set on the object state.

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.