Exchange Toolkit
Public Member Functions | List of all members
ts3d::Instance Class Reference

An instance should be thought of as a specific path through the Exchange product structure to a particular leaf entity. More...

#include <ExchangeToolkit.h>

Inheritance diagram for ts3d::Instance:
ts3d::RepresentationItemInstance ts3d::TessBaseInstance ts3d::Tess3DInstance ts3d::Tess3DWireInstance

Public Member Functions

 Instance (InstancePath const &path)
 Constructs an Instance from the provided InstancePath.
 
 Instance (Instance const &other)
 Copy constructor.
 
 Instance (Instance &&other)
 Move constructor.
 
virtual ~Instance (void)
 Destructor.
 
Instanceoperator= (Instance const &other)
 Assignment.
 
Instanceoperator= (Instance &&other)
 Move assign.
 
bool operator== (Instance const &other) const
 Compare paths.
 
std::string getName (void) const
 Gets the object name.
 
std::string getType (void) const
 Gets the object type as a string.
 
InstancePath const & path (void) const
 Gets the InstancePath this Instance references.
 
Instance owner (void) const
 Gets an Instance object for the parent.
 
void reset (InstancePath const &new_path)
 Resets the InstancePath this Instance references.
 
A3DEntity * leaf (void) const
 Gets the leaf entity pointer.
 
A3DEEntityType leafType (void) const
 Gets the type of the leaf entity.
 
Net attribute getters
bool getNetRemoved (void) const
 Gets the net removed.
 
bool getNetShow (void) const
 Gets the net show.
 
A3DGraphStyleData getNetStyle (void) const
 Gets the net style.
 
A3DUns16 getNetLayer (void) const
 Gets the net layer.
 

Detailed Description

An instance should be thought of as a specific path through the Exchange product structure to a particular leaf entity.

Since the path to an entity provides context into how attributes should be interpretted, this class encapsulates the information via its InstancePath.


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