HPS::Exchange::Layer Class Reference

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::Layer:
HPS::Sprocket HPS::Object

Public Member Functions

ComponentArray GetComponents () const
 
unsigned int GetIdentifier () const
 
HPS::UTF8 GetName () const
 
ProductOccurrence GetProductOccurrence () const
 
 Layer ()
 
 Layer (Layer const &in_that)
 
 Layer (Layer &&in_that)
 
HPS::Type ObjectType () const
 
Layeroperator= (Layer const &in_that)
 
Layeroperator= (Layer &&in_that)
 
- Public Member Functions inherited from HPS::Sprocket
Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ExchangeLayer
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The Filter class is a smart pointer. It represents an A3DAsmLayer in Exchange. The primary purpose of this class is simply to provide access to the underlying A3DAsmLayer pointer for use by Exchange library functions.

Constructor & Destructor Documentation

◆ Layer() [1/3]

HPS::Exchange::Layer::Layer ( )

The default constructor creates an uninitialized Layer object. The Type() function will return Type::None.

◆ Layer() [2/3]

HPS::Exchange::Layer::Layer ( Layer const &  in_that)

The copy constructor creates an Exchange::Layer object that shares the underlying smart-pointer of the source Exchange::Layer.

Parameters
in_thatThe source Exchange::Layer to copy.

◆ Layer() [3/3]

HPS::Exchange::Layer::Layer ( Layer &&  in_that)

The move constructor creates an Exchange::Layer by transferring the underlying object of the rvalue reference to this Exchange::Layer.

Parameters
in_thatAn rvalue reference to an Exchange::Layer to take the underlying object from.

Member Function Documentation

◆ GetComponents()

ComponentArray HPS::Exchange::Layer::GetComponents ( ) const

Get the list of components in this layer.

Returns
A list of components in this layer.

◆ GetIdentifier()

unsigned int HPS::Exchange::Layer::GetIdentifier ( ) const

Get the identifier of the layer.

Returns
The identifier of the layer.

◆ GetName()

HPS::UTF8 HPS::Exchange::Layer::GetName ( ) const

Get the layer name.

Returns
The name of the layer.

◆ GetProductOccurrence()

ProductOccurrence HPS::Exchange::Layer::GetProductOccurrence ( ) const

Get the product occurrence in which the layer is defined.

Returns
The product occurrence in which the layer is defined.

◆ ObjectType()

HPS::Type HPS::Exchange::Layer::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Object.

◆ operator=() [1/2]

Layer& HPS::Exchange::Layer::operator= ( Layer const &  in_that)

The copy assignment operator copies the underlying impl of the source value to this Layer.

Parameters
in_thatThe source Layer to copy.
Returns
A reference to this Layer.

◆ operator=() [2/2]

Layer& HPS::Exchange::Layer::operator= ( Layer &&  in_that)

The move assignment operator transfers the underlying object of the rvalue reference to this Exchange::Layer.

Parameters
in_thatAn rvalue reference to an Exchange::Layer to take the underlying object from.
Returns
A reference to this Exchange::Layer.

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