ufe 5.5
Universal Front End is a DCC-agnostic component that will allow a DCC to browse and edit data in multiple data models
Ufe::AttributeInfo Class Reference

This class keeps information of an attribute. More...

#include <attributeInfo.h>

Collaboration diagram for Ufe::AttributeInfo:

Public Member Functions

 AttributeInfo (const Attribute::Ptr &attr)
 
 AttributeInfo (const Path &path, const std::string &name)
 
 AttributeInfo (const AttributeInfo &attr)=default
 
 ~AttributeInfo ()
 
Rtid runTimeId () const
 
Path path () const
 
std::string name () const
 
Attribute::Ptr attribute () const
 Create the Attribute from the AttributeInfo. More...
 

Private Attributes

const Path fNodePath
 
const std::string fAttributeName
 

Detailed Description

This class keeps information of an attribute.

This class keeps the information of an attribute when long-term usage is mandatory such as an undo/redo commands for example. The information remains valid even if the node owning this attribute is deleted. The Attribute class keeps a handle associated to a specific node instance so, deleting the node instance invalidates the Attribute instance.

Definition at line 34 of file attributeInfo.h.

Constructor & Destructor Documentation

◆ AttributeInfo() [1/3]

Ufe::AttributeInfo::AttributeInfo ( const Attribute::Ptr attr)

◆ AttributeInfo() [2/3]

Ufe::AttributeInfo::AttributeInfo ( const Path path,
const std::string &  name 
)

◆ AttributeInfo() [3/3]

Ufe::AttributeInfo::AttributeInfo ( const AttributeInfo attr)
default

◆ ~AttributeInfo()

Ufe::AttributeInfo::~AttributeInfo ( )

Member Function Documentation

◆ attribute()

Attribute::Ptr Ufe::AttributeInfo::attribute ( ) const

Create the Attribute from the AttributeInfo.

Note
This method could have a performance hit.

◆ name()

std::string Ufe::AttributeInfo::name ( ) const
inline

Definition at line 44 of file attributeInfo.h.

◆ path()

Path Ufe::AttributeInfo::path ( ) const
inline

Definition at line 43 of file attributeInfo.h.

◆ runTimeId()

Rtid Ufe::AttributeInfo::runTimeId ( ) const
inline

Definition at line 42 of file attributeInfo.h.

Member Data Documentation

◆ fAttributeName

const std::string Ufe::AttributeInfo::fAttributeName
private

Definition at line 54 of file attributeInfo.h.

◆ fNodePath

const Path Ufe::AttributeInfo::fNodePath
private

Definition at line 53 of file attributeInfo.h.


The documentation for this class was generated from the following file: