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

Public Member Functions

 Configuration ()
 
 Configuration (string in_name)
 
 Configuration (string in_name, HPS.Exchange.Configuration[] in_subconfigurations)
 
 Configuration (HPS.Exchange.Configuration in_configuration)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.Configuration in_kit)
 
override int GetHashCode ()
 
string GetName ()
 
HPS.Exchange.Configuration [] GetSubconfigurations ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.Configuration in_kit)
 
void Show (out HPS.Exchange.Configuration out_kit)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

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

- Protected Attributes inherited from HPS.Object
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

◆ Configuration() [1/4]

HPS.Exchange.Configuration.Configuration ( )
inline

The default constructor creates an empty Configuration object.

◆ Configuration() [2/4]

HPS.Exchange.Configuration.Configuration ( string  in_name)
inline

This constructor creates a Configuration with the given name and no subconfigurations.

Parameters
in_nameUTF8-encoded string with the name for this Configuration.

◆ Configuration() [3/4]

HPS.Exchange.Configuration.Configuration ( string  in_name,
HPS.Exchange.Configuration []  in_subconfigurations 
)
inline

This constructor creates a Configuration with the given name and the given subconfigurations

Parameters
in_nameUTF8-encoded string with the name for this Configuration.
in_subconfigurationsThe subconfigurations for this Configuration.

◆ Configuration() [4/4]

HPS.Exchange.Configuration.Configuration ( HPS.Exchange.Configuration  in_configuration)
inline

The copy constructor creates a new Configuration object that contains the same settings as the source Configuration.

Parameters
in_configurationThe source Configuration to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Exchange.Configuration.Empty ( )
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.

◆ Equals()

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

Check if the source Configuration is equivalent to this Configuration.

Parameters
in_kitThe source Configuration to compare to this Configuration.
Returns
true if the objects are equivalent, false otherwise.

◆ GetName()

string HPS.Exchange.Configuration.GetName ( )
inline

Gets the name for this Configuration.

Returns
The name for this Configuration.

◆ GetSubconfigurations()

HPS.Exchange.Configuration [] HPS.Exchange.Configuration.GetSubconfigurations ( )
inline

Gets the subconfigurations for this Configuration.

Returns
The subconfigurations for this Configuration.

◆ ObjectType()

override HPS.Type HPS.Exchange.Configuration.ObjectType ( )
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.

◆ Set()

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

Copies the source Configuration into this Configuration.

Parameters
in_kitThe source Configuration to copy.

◆ Show()

void HPS.Exchange.Configuration.Show ( out HPS.Exchange.Configuration  out_kit)
inline

Copies this Configuration into the given Configuration.

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