#include <sprk_exchange.h>
Public Member Functions | |
Configuration () | |
Configuration (char const *in_name) | |
Configuration (char const *in_name, size_t in_count, Configuration const in_subconfigurations[]) | |
Configuration (char const *in_name, ConfigurationArray const &in_subconfigurations) | |
Configuration (Configuration const &in_configuration) | |
Configuration (Configuration &&in_that) | |
Configuration & | operator= (Configuration &&in_that) |
HPS::Type | ObjectType () const |
void | Set (Configuration const &in_kit) |
void | Show (Configuration &out_kit) const |
Configuration & | operator= (Configuration const &in_kit) |
bool | Empty () const |
bool | Equals (Configuration const &in_kit) const |
bool | operator== (Configuration const &in_kit) const |
bool | operator!= (Configuration const &in_kit) const |
HPS::UTF8 | GetName () const |
ConfigurationArray | GetSubconfigurations () const |
![]() | |
Sprocket (HPS::Sprocket const &in_that)=default | |
Sprocket (Sprocket &&in_that) | |
![]() | |
Object (Object const &that) | |
Object & | operator= (Object const &other_object) |
Object (Object &&in_that) | |
Object & | operator= (Object &&in_that) |
HPS::Type | Type () const |
virtual void | Reset () |
bool | HasType (HPS::Type in_mask) const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The Configuration class is a user space object. It is a used to get configuration information for a CAD file.
HPS::Exchange::Configuration::Configuration | ( | ) |
The default constructor creates an empty Configuration object.
HPS::Exchange::Configuration::Configuration | ( | char const * | in_name | ) |
This constructor creates a Configuration with the given name and no subconfigurations.
in_name | UTF8-encoded string with the name for this Configuration. |
HPS::Exchange::Configuration::Configuration | ( | char const * | in_name, |
size_t | in_count, | ||
Configuration const | in_subconfigurations[] | ||
) |
This constructor creates a Configuration with the given name and the given subconfigurations
in_name | UTF8-encoded string with the name for this Configuration. |
in_count | Size of the following array. |
in_subconfigurations | The subconfigurations for this Configuration. |
HPS::Exchange::Configuration::Configuration | ( | char const * | in_name, |
ConfigurationArray const & | in_subconfigurations | ||
) |
This constructor creates a Configuration with the given name and the given subconfigurations
in_name | UTF8-encoded string with the name for this Configuration. |
in_subconfigurations | The subconfigurations for this Configuration. |
HPS::Exchange::Configuration::Configuration | ( | Configuration const & | in_configuration | ) |
The copy constructor creates a new Configuration object that contains the same settings as the source Configuration.
in_configuration | The source Configuration to copy. |
HPS::Exchange::Configuration::Configuration | ( | Configuration && | in_that | ) |
The move constructor creates an Configuration by transferring the underlying impl of the rvalue reference to this Configuration thereby avoiding a copy and allocation.
in_that | An rvalue reference to an Configuration to take the impl from. |
|
virtual |
Indicates whether this Configuration has any values set on it.
Reimplemented from HPS::Object.
bool HPS::Exchange::Configuration::Equals | ( | Configuration const & | in_kit | ) | const |
Check if the source Configuration is equivalent to this Configuration.
in_kit | The source Configuration to compare to this Configuration. |
HPS::UTF8 HPS::Exchange::Configuration::GetName | ( | ) | const |
Gets the name for this Configuration.
ConfigurationArray HPS::Exchange::Configuration::GetSubconfigurations | ( | ) | const |
Gets the subconfigurations for this Configuration.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Object.
bool HPS::Exchange::Configuration::operator!= | ( | Configuration const & | in_kit | ) | const |
Check if the source Configuration is not equivalent to this Configuration.
in_kit | The source Configuration to compare to this Configuration. |
Configuration& HPS::Exchange::Configuration::operator= | ( | Configuration && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this Configuration thereby avoiding a copy.
in_that | An rvalue reference to an Configuration to take the impl from. |
Configuration& HPS::Exchange::Configuration::operator= | ( | Configuration const & | in_kit | ) |
Copies the source Configuration into this Configuration.
in_kit | The source Configuration to copy. |
bool HPS::Exchange::Configuration::operator== | ( | Configuration const & | in_kit | ) | const |
Check if the source Configuration is equivalent to this Configuration.
in_kit | The source Configuration to compare to this Configuration. |
void HPS::Exchange::Configuration::Set | ( | Configuration const & | in_kit | ) |
Copies the source Configuration into this Configuration.
in_kit | The source Configuration to copy. |
void HPS::Exchange::Configuration::Show | ( | Configuration & | out_kit | ) | const |
Copies this Configuration into the given Configuration.
out_kit | The Configuration to populate with the contents of this Configuration. |