REFERENCE MANUAL
The Configuration class is a user space object. More...
Public Member Functions | |
Configuration () | |
The default constructor creates an empty Configuration object. More... | |
Configuration (string in_name) | |
This constructor creates a Configuration with the given name and no subconfigurations. More... | |
Configuration (string in_name, HPS.Exchange.Configuration[] in_subconfigurations) | |
This constructor creates a Configuration with the given name and the given subconfigurations More... | |
Configuration (HPS.Exchange.Configuration in_configuration) | |
The copy constructor creates a new Configuration object that contains the same settings as the source Configuration. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this Configuration has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.Configuration in_kit) |
Check if the source Configuration is equivalent to this Configuration. More... | |
override int | GetHashCode () |
string | GetName () |
Gets the name for this Configuration. More... | |
HPS.Exchange.Configuration[] | GetSubconfigurations () |
Gets the subconfigurations for this Configuration. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.Exchange.Configuration in_kit) |
Copies the source Configuration into this Configuration. More... | |
void | Show (out HPS.Exchange.Configuration out_kit) |
Copies this Configuration into the given Configuration. More... | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.Exchange.Configuration a, HPS.Exchange.Configuration b) |
static bool | operator== (HPS.Exchange.Configuration a, HPS.Exchange.Configuration b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous = 0, Asynchronous = 1 } |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
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 | ( | string | in_name | ) |
This constructor creates a Configuration with the given name and no subconfigurations.
in_name | UTF8-encoded string with the name for this <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref>. |
HPS.Exchange.Configuration.Configuration | ( | string | in_name, |
HPS.Exchange.Configuration[] | 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 <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref>. |
in_count | Size of the following array. |
in_subconfigurations | The subconfigurations for this <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref>. |
HPS.Exchange.Configuration.Configuration | ( | HPS.Exchange.Configuration | in_configuration | ) |
The copy constructor creates a new Configuration object that contains the same settings as the source Configuration.
in_configuration | The source <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref> to copy. |
|
virtual |
Indicates whether this Configuration has any values set on it.
Reimplemented from HPS.Object.
bool HPS.Exchange.Configuration.Equals | ( | HPS.Exchange.Configuration | in_kit | ) |
Check if the source Configuration is equivalent to this Configuration.
in_kit | The source <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref> to compare to this <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref>. |
string HPS.Exchange.Configuration.GetName | ( | ) |
Gets the name for this Configuration.
HPS.Exchange.Configuration [] HPS.Exchange.Configuration.GetSubconfigurations | ( | ) |
Gets the subconfigurations for this Configuration.
|
virtual |
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.
void HPS.Exchange.Configuration.Set | ( | HPS.Exchange.Configuration | in_kit | ) |
Copies the source Configuration into this Configuration.
in_kit | The source <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref> to copy. |
void HPS.Exchange.Configuration.Show | ( | out HPS.Exchange.Configuration | out_kit | ) |
Copies this Configuration into the given Configuration.
out_kit | The <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref>. |