< Home

< Table of Contents

REFERENCE MANUAL

HPS.Exchange.Configuration Class Reference

The Configuration class is a user space object. More...

Inheritance diagram for HPS.Exchange.Configuration:
HPS.Sprocket HPS.Object

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...
 
- Public Member Functions inherited from HPS.Sprocket
 Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
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 Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Public Types inherited from HPS.Sprocket
enum  UpdateType { Synchronous = 0, Asynchronous = 1 }
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 
HandleRef scptr
 

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

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.

Parameters
in_nameUTF8-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

Parameters
in_nameUTF8-encoded string with the name for this <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref>.
in_countSize of the following array.
in_subconfigurationsThe 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.

Parameters
in_configurationThe source <ref refid="class_h_p_s_1_1_exchange_1_1_configuration" kindref="compound">Configuration</ref> to copy.

Member Function Documentation

override bool HPS.Exchange.Configuration.Empty ( )
virtual

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.

bool HPS.Exchange.Configuration.Equals ( HPS.Exchange.Configuration  in_kit)

Check if the source Configuration is equivalent to this Configuration.

Parameters
in_kitThe 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>.
Returns
true if the objects are equivalent, false otherwise.
string HPS.Exchange.Configuration.GetName ( )

Gets the name for this Configuration.

Returns
The name for this Configuration.
HPS.Exchange.Configuration [] HPS.Exchange.Configuration.GetSubconfigurations ( )

Gets the subconfigurations for this Configuration.

Returns
The subconfigurations for this Configuration.
override HPS.Type HPS.Exchange.Configuration.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

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

Reimplemented from HPS.Object.

void HPS.Exchange.Configuration.Set ( HPS.Exchange.Configuration  in_kit)

Copies the source Configuration into this Configuration.

Parameters
in_kitThe 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.

Parameters
out_kitThe <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>.

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