
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 (if the object is derived, this does not give the true type of the derived object). 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 the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
virtual HPS.Type | Type () |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. 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 | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The Configuration class is a user space object. It is a used to get configuration information for a CAD file.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty Configuration object.
|
inline |
This constructor creates a Configuration with the given name and no subconfigurations.
- Parameters
-
in_name UTF8-encoded string with the name for this Configuration.
|
inline |
This constructor creates a Configuration with the given name and the given subconfigurations
- Parameters
-
in_name UTF8-encoded string with the name for this Configuration. in_subconfigurations The subconfigurations for this Configuration.
|
inline |
The copy constructor creates a new Configuration object that contains the same settings as the source Configuration.
- Parameters
-
in_configuration The source Configuration to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this Configuration has any values set on it.
- Returns
- true if no values are set on this Configuration, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source Configuration is equivalent to this Configuration.
- Parameters
-
in_kit The source Configuration to compare to this Configuration.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Gets the name for this Configuration.
- Returns
- The name for this Configuration.
|
inline |
Gets the subconfigurations for this Configuration.
- Returns
- The subconfigurations for this Configuration.
|
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.
|
inline |
Copies the source Configuration into this Configuration.
- Parameters
-
in_kit The source Configuration to copy.
|
inline |
Copies this Configuration into the given Configuration.
- Parameters
-
out_kit The Configuration to populate with the contents of this Configuration.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs