Inheritance diagram for HPS.Exchange.ExportXMLOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportXMLOptionsKit in_kit)
 
 ExportXMLOptionsKit ()
 
 ExportXMLOptionsKit (HPS.Exchange.ExportXMLOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportXMLOptionsKit in_kit)
 
HPS.Exchange.ExportXMLOptionsKit SetMaterials (bool in_state)
 
HPS.Exchange.ExportXMLOptionsKit SetMetadata (bool in_state)
 
HPS.Exchange.ExportXMLOptionsKit SetTransformations (bool in_state)
 
void Show (out HPS.Exchange.ExportXMLOptionsKit out_kit)
 
bool ShowMaterials (out bool out_state)
 
bool ShowMetadata (out bool out_state)
 
bool ShowTransformations (out bool out_state)
 
HPS.Exchange.ExportXMLOptionsKit UnsetEverything ()
 
HPS.Exchange.ExportXMLOptionsKit UnsetMaterials ()
 
HPS.Exchange.ExportXMLOptionsKit UnsetMetadata ()
 
HPS.Exchange.ExportXMLOptionsKit UnsetTransformations ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- 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 HPS.Exchange.ExportXMLOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportXMLOptionsKit a, HPS.Exchange.ExportXMLOptionsKit 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 HPS.Exchange.ExportXMLOptionsKit class is a user space object. It contains settings controlling how XML data is exported via Exchange. Calling HPS.Exchange.ExportXMLOptionsKit.GetDefault() will return an options kit with values found in here.

Constructor & Destructor Documentation

◆ ExportXMLOptionsKit() [1/2]

HPS.Exchange.ExportXMLOptionsKit.ExportXMLOptionsKit ( )
inline

The default constructor creates an empty ExportXMLOptionsKit object.

◆ ExportXMLOptionsKit() [2/2]

HPS.Exchange.ExportXMLOptionsKit.ExportXMLOptionsKit ( HPS.Exchange.ExportXMLOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportXMLOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Exchange.ExportXMLOptionsKit.Empty ( )
inlinevirtual

Indicates whether this ExportXMLOptionsKit has any values set on it.

Returns
true if no values are set on this ExportXMLOptionsKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit.

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

◆ GetDefault()

static HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.GetDefault ( )
inlinestatic

Creates an ExportXMLOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. These values will be used for import unless an option is overridden by the options passed to File.ExportXML.

Returns
An ExportXMLOptionsKit with the default settings.

◆ ObjectType()

override HPS.Type HPS.Exchange.ExportXMLOptionsKit.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.SprocketKit.

◆ Set()

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

Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit.

Parameters
in_kitThe source ExportXMLOptionsKit to copy.

◆ SetMaterials()

HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.SetMaterials ( bool  in_state)
inline

Sets whether to export materials. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportColorMaterial.

Parameters
in_stateWhether to export materials.
Returns
A reference to this ExportXMLOptionsKit.
See also
Default value

◆ SetMetadata()

HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.SetMetadata ( bool  in_state)
inline

Sets whether to export metadata. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportMetadata.

Parameters
in_stateWhether to export metadata.
Returns
A reference to this ExportXMLOptionsKit.
See also
Default value

◆ SetTransformations()

HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.SetTransformations ( bool  in_state)
inline

Sets whether to export transformations. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportTransformations.

Parameters
in_stateWhether to export transformations.
Returns
A reference to this ExportXMLOptionsKit.
See also
Default value

◆ Show()

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

Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit.

Parameters
out_kitThe ExportXMLOptionsKit to populate with the contents of this ExportXMLOptionsKit.

◆ ShowMaterials()

bool HPS.Exchange.ExportXMLOptionsKit.ShowMaterials ( out bool  out_state)
inline

Shows the material export setting.

Parameters
out_stateWhether to export materials.
Returns
true if a material export setting was specified, false otherwise.

◆ ShowMetadata()

bool HPS.Exchange.ExportXMLOptionsKit.ShowMetadata ( out bool  out_state)
inline

Shows the metadata export setting.

Parameters
out_stateWhether to export metadata.
Returns
true if a metadata export setting was specified, false otherwise.

◆ ShowTransformations()

bool HPS.Exchange.ExportXMLOptionsKit.ShowTransformations ( out bool  out_state)
inline

Shows the transformation export setting.

Parameters
out_stateWhether to export transformations.
Returns
true if a transformation export setting was specified, false otherwise.

◆ UnsetEverything()

HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportXMLOptionsKit.

Returns
A reference to this ExportXMLOptionsKit.

◆ UnsetMaterials()

HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetMaterials ( )
inline

Removes the material export setting.

Returns
A reference to this ExportXMLOptionsKit.

◆ UnsetMetadata()

HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetMetadata ( )
inline

Removes the metadata export setting.

Returns
A reference to this ExportXMLOptionsKit.

◆ UnsetTransformations()

HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetTransformations ( )
inline

Removes the transformation export setting.

Returns
A reference to this ExportXMLOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs