API Search || Global Search

More...

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

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 Indicates whether this ExportXMLOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportXMLOptionsKit in_kit)
 Check if the source ExportXMLOptionsKit is equivalent to this ExportXMLOptionsKit. More...
 
 ExportXMLOptionsKit ()
 The default constructor creates an empty ExportXMLOptionsKit object. More...
 
 ExportXMLOptionsKit (HPS.Exchange.ExportXMLOptionsKit in_kit)
 The copy constructor creates a new ExportXMLOptionsKit object that contains the same settings as the source ExportXMLOptionsKit. More...
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Set (HPS.Exchange.ExportXMLOptionsKit in_kit)
 Copies the source ExportXMLOptionsKit into this ExportXMLOptionsKit. More...
 
HPS.Exchange.ExportXMLOptionsKit SetMaterials (bool in_state)
 Sets whether to export materials. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportColorMaterial. More...
 
HPS.Exchange.ExportXMLOptionsKit SetMetadata (bool in_state)
 Sets whether to export metadata. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportMetadata. More...
 
HPS.Exchange.ExportXMLOptionsKit SetTransformations (bool in_state)
 Sets whether to export transformations. This corresponds to the value that will be passed to A3DRWParamsExportXMLData::m_bExportTransformations. More...
 
void Show (out HPS.Exchange.ExportXMLOptionsKit out_kit)
 Copies this ExportXMLOptionsKit into the given ExportXMLOptionsKit. More...
 
bool ShowMaterials (out bool out_state)
 Shows the material export setting. More...
 
bool ShowMetadata (out bool out_state)
 Shows the metadata export setting. More...
 
bool ShowTransformations (out bool out_state)
 Shows the transformation export setting. More...
 
HPS.Exchange.ExportXMLOptionsKit UnsetEverything ()
 Removes all settings from this ExportXMLOptionsKit. More...
 
HPS.Exchange.ExportXMLOptionsKit UnsetMaterials ()
 Removes the material export setting. More...
 
HPS.Exchange.ExportXMLOptionsKit UnsetMetadata ()
 Removes the metadata export setting. More...
 
HPS.Exchange.ExportXMLOptionsKit UnsetTransformations ()
 Removes the transformation export setting. More...
 
- 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 ()
 Returns an identifier that can be used to identify which instance of a class an object is. 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
HPS.Exchange.ExportXMLOptionsKit 
GetDefault ()
 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. More...
 
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

HPS.Exchange.ExportXMLOptionsKit.ExportXMLOptionsKit ( )
inline

The default constructor creates an empty ExportXMLOptionsKit object.

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

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.

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

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.SprocketKit.

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

Default value

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.

Default value

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.

Default value

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.
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.
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.
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.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportXMLOptionsKit.

Returns
    A reference to this ExportXMLOptionsKit.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetMaterials ( )
inline

Removes the material export setting.

Returns
    A reference to this ExportXMLOptionsKit.
HPS.Exchange.ExportXMLOptionsKit HPS.Exchange.ExportXMLOptionsKit.UnsetMetadata ( )
inline

Removes the metadata export setting.

Returns
    A reference to this ExportXMLOptionsKit.
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