API Search || Global Search
HPS::NamedStyleDefinition Class Reference

#include <hps.h>

Inheritance diagram for HPS::NamedStyleDefinition:
HPS::Definition HPS::Object

Public Member Functions

SegmentKey GetSource () const
 
 NamedStyleDefinition ()
 
 NamedStyleDefinition (Definition const &in_that)
 
 NamedStyleDefinition (NamedStyleDefinition const &in_that)
 
 NamedStyleDefinition (NamedStyleDefinition &&in_that)
 
HPS::Type ObjectType () const
 
NamedStyleDefinitionoperator= (NamedStyleDefinition const &in_that)
 
NamedStyleDefinitionoperator= (NamedStyleDefinition &&in_that)
 
- Public Member Functions inherited from HPS::Definition
virtual void Assign (Definition const &in_that)
 
 Definition ()
 
 Definition (Definition const &in_that)
 
 Definition (Definition &&in_that)
 
bool Equals (Definition const &in_that) const
 
UTF8 Name () const
 
bool operator!= (Definition const &in_that) const
 
Definitionoperator= (Definition const &in_that)
 
Definitionoperator= (Definition &&in_that)
 
bool operator== (Definition const &in_that) const
 
PortfolioKey Owner () const
 
void Undefine ()
 
- 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::NamedStyleDefinition
 
- Static Public Attributes inherited from HPS::Definition
static const HPS::Type staticType = HPS::Type::Definition
 
- 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 NamedStyleDefinition class is a smart pointer to a database object. It is a handle to a named style defined within a portfolio.

Constructor & Destructor Documentation

HPS::NamedStyleDefinition::NamedStyleDefinition ( )

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

HPS::NamedStyleDefinition::NamedStyleDefinition ( Definition const &  in_that)

This constructor creates a NamedStyleDefinition object that shares the underlying smart-pointer of the source Definition. The copy will only be successful if the source definition is really an upcast of a named style definition. Otherwise the copy will fail and the resulting NamedStyleDefinition will be invalid.

Parameters
in_thatThe source Definition to copy.
HPS::NamedStyleDefinition::NamedStyleDefinition ( NamedStyleDefinition const &  in_that)

The copy constructor creates a NamedStyleDefinition object that shares the underlying smart-pointer of the source NamedStyleDefinition.

Parameters
in_thatThe source NamedStyleDefinition to copy.
HPS::NamedStyleDefinition::NamedStyleDefinition ( NamedStyleDefinition &&  in_that)

The move constructor creates a NamedStyleDefinition by transferring the underlying impl of the rvalue reference to this NamedStyleDefinition thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a NamedStyleDefinition to take the impl from.

Member Function Documentation

SegmentKey HPS::NamedStyleDefinition::GetSource ( ) const

Get the source segment for this NamedStyleDefinition.

Returns
The source segment for this NamedStyleDefinition. This is the segment that contains attributes that are associated with this named style.
NamedStyleDefinition& HPS::NamedStyleDefinition::operator= ( NamedStyleDefinition const &  in_that)

Associate this NamedStyleDefinition with the same underlying impl as the source NamedStyleDefinition.

Parameters
in_thatThe source NamedStyleDefinition for the assignment.
Returns
A reference to this NamedStyleDefinition.
NamedStyleDefinition& HPS::NamedStyleDefinition::operator= ( NamedStyleDefinition &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this NamedStyleDefinition thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a NamedStyleDefinition to take the impl from.
Returns
A reference to this NamedStyleDefinition.

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