REFERENCE MANUAL
The Filter class is a smart pointer. More...
Public Member Functions | |
void | Activate (HPS.View in_view) |
Activates this Filter on a given View. More... | |
void | Deactivate (HPS.View in_view) |
Dectivates this Filter on a given View. More... | |
override void | Dispose () |
Filter () | |
The default constructor creates an uninitialized Filter object. More... | |
Filter (HPS.Component in_that) | |
This constructor creates a Filter object that shares the underlying smart-pointer of the source Component. More... | |
Filter (HPS.Filter in_that) | |
This constructor creates a Filter object that shares the underlying smart-pointer of the source Component. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
![]() | |
void | AddKey (HPS.Key in_key) |
Adds a key to be associated with this Component. More... | |
void | AddOwner (HPS.Component in_owner, HPS.IncludeKey in_include) |
Adds an owner to this Component. More... | |
void | AddOwner (HPS.Component in_owner) |
Adds an owner to this Component. More... | |
void | AddReference (HPS.Component in_reference) |
Adds a Component as a reference to this Component. More... | |
virtual void | Assign (HPS.Component in_that) |
Share the underlying smart-pointer of the Component source. More... | |
Component () | |
The default constructor creates an uninitialized Component object. More... | |
Component (HPS.Component in_that) | |
The copy constructor creates a Component object that shares the underlying smart-pointer of the source Component. More... | |
void | Delete () |
Removes all references owning Components have to this Component, deletes all owned subcomponents, and deletes any underlying keys. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Component in_that) |
Check if the source Component points to the same underlying impl as this Component. More... | |
HPS.Metadata[] | GetAllMetadata () |
Get all Metadata objects associated with this Component. More... | |
HPS.Component[] | GetAllSubcomponents (HPS.Component.ComponentType in_type) |
Gets all components under this Component that have the specified ComponentType mask. More... | |
HPS.Component.ComponentType | GetComponentType () |
Gets the specific format-dependent type this Component represents. More... | |
override int | GetHashCode () |
HPS.Key[] | GetKeys () |
Get the underlying keys (if any) which represent this Component. More... | |
HPS.Metadata | GetMetadata (string in_name) |
Get the single Metadata object with the given name associated with this Component (if present). More... | |
HPS.Component[] | GetOwners () |
Get the Component objects (if any) which "own" this Component. More... | |
HPS.Component[] | GetReferences () |
Get the Component objects (if any) which are referenced by this Component. More... | |
HPS.Component[] | GetReferrers () |
Gets the Component objects which refer to this Component (if any). More... | |
HPS.Component[] | GetSubcomponents () |
Get the subcomponent objects (if any) owned or referenced by this Component. More... | |
bool | HasComponentType (HPS.Component.ComponentType in_mask) |
This function indicates whether this Component has the given ComponentType mask. More... | |
![]() | |
override void | Dispose () |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
The Filter class is a smart pointer.
It represents a filter, i.e., a collection of visibility settings for a CADModel.
HPS.Filter.Filter | ( | ) |
HPS.Filter.Filter | ( | HPS.Component | in_that | ) |
This constructor creates a Filter object that shares the underlying smart-pointer of the source Component.
The copy will only be successful if the source component is really an upcast of a Filter object. Otherwise the copy will fail and the resulting Filter will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_component" kindref="compound">Component</ref> to copy. |
HPS.Filter.Filter | ( | HPS.Filter | in_that | ) |
This constructor creates a Filter object that shares the underlying smart-pointer of the source Component.
The copy will only be successful if the source component is really an upcast of a Filter object. Otherwise the copy will fail and the resulting Filter will be invalid.
in_that | The source <ref refid="class_h_p_s_1_1_component" kindref="compound">Component</ref> to copy. |
void HPS.Filter.Activate | ( | HPS.View | in_view | ) |
void HPS.Filter.Deactivate | ( | HPS.View | in_view | ) |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Component.
Reimplemented in HPS.Exchange.Filter.