Overview

Sample Code

Programming Guide

API Reference

Support

HPS::Exchange::Sheet Class Reference

#include <sprk_exchange.h>

Inheritance diagram for HPS::Exchange::Sheet:
HPS::Exchange::Component HPS::Component HPS::Sprocket HPS::Object

Public Member Functions

HPS::View Activate ()
 
bool Equals (Sheet const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (Sheet const &in_kit) const
 
Sheetoperator= (Sheet &&in_that)
 
Sheetoperator= (Sheet const &in_that)=default
 
bool operator== (Sheet const &in_kit) const
 
 Sheet ()
 
 Sheet (HPS::Component const &in_that)
 
 Sheet (Component const &in_that)
 
 Sheet (Sheet const &in_sheet)
 
 Sheet (Sheet &&in_that)
 
- Public Member Functions inherited from HPS::Exchange::Component
 Component ()
 
 Component (HPS::Component const &in_that)
 
 Component (Exchange::Component const &in_that)
 
 Component (Exchange::Component &&in_that)
 
A3DEntity * GetExchangeEntity () const
 
Componentoperator= (Component const &in_that)=default
 
Componentoperator= (Exchange::Component &&in_that)
 
ReloadNotifier Reload (TessellationOptionsKit const &in_tessellation_options=TessellationOptionsKit(), TranslationOptionsKit const &in_translation_options=TranslationOptionsKit())
 
void Tessellate (TessellationOptionsKit const &in_options)
 
TranslationNotifier Translate (Units in_units, TranslationOptionsKit const &in_translation_options)
 
virtual ~Component ()
 
- Public Member Functions inherited from HPS::Component
void AddKey (Key const &in_key)
 
void AddOwner (Component &in_owner, IncludeKey const &in_include=IncludeKey())
 
void AddReference (Component &in_reference)
 
virtual void Assign (Component const &in_that)
 
 Component ()
 
 Component (Component const &in_that)
 
 Component (Component &&in_that)
 
void Delete ()
 
bool Equals (Component const &in_that) const
 
void Flush ()
 
MetadataArray GetAllMetadata () const
 
ComponentArray GetAllSubcomponents (ComponentType in_type) const
 
ComponentType GetComponentType () const
 
KeyArray GetKeys () const
 
Metadata GetMetadata (char const *in_name) const
 
UTF8 GetName () const
 
ComponentArray GetOwners () const
 
ComponentArray GetReferences () const
 
ComponentArray GetReferrers () const
 
ComponentArray GetSubcomponents () const
 
bool HasComponentType (ComponentType in_mask) const
 
bool operator!= (Component const &in_that) const
 
Componentoperator= (Component const &in_that)
 
Componentoperator= (Component &&in_that)
 
bool operator== (Component const &in_that) const
 
- Public Member Functions inherited from HPS::Sprocket
 Sprocket (HPS::Sprocket const &in_that)=default
 
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
HPS::Type Type () const
 

Additional Inherited Members

- Public Types inherited from HPS::Component
enum  ComponentType : uint32_t {
  None = 0x00000000, GenericMask = 0xfffff000, ComponentType::ExchangeComponentMask = 0x00001000, ComponentType::ExchangeModelFile = 0x00001001,
  ComponentType::ExchangeProductOccurrence = 0x00001002, ComponentType::ExchangePartDefinition = 0x00001003, ComponentType::ExchangeView = 0x00001004, ComponentType::ExchangeFilter = 0x00001005,
  ComponentType::ExchangeRepresentationItemMask = 0x00003000, ComponentType::ExchangeRIBRepModel = 0x00003001, ComponentType::ExchangeRICurve = 0x00003002, ComponentType::ExchangeRIDirection = 0x00003003,
  ComponentType::ExchangeRIPlane = 0x00003004, ComponentType::ExchangeRIPointSet = 0x00003005, ComponentType::ExchangeRIPolyBRepModel = 0x00003006, ComponentType::ExchangeRIPolyWire = 0x00003007,
  ComponentType::ExchangeRISet = 0x00003008, ComponentType::ExchangeRICoordinateSystem = 0x00003009, ComponentType::ExchangeTopologyMask = 0x00005000, ComponentType::ExchangeTopoBody = 0x00005001,
  ComponentType::ExchangeTopoConnex = 0x00005002, ComponentType::ExchangeTopoShell = 0x00005003, ComponentType::ExchangeTopoFace = 0x00005004, ComponentType::ExchangeTopoLoop = 0x00005005,
  ComponentType::ExchangeTopoCoEdge = 0x00005006, ComponentType::ExchangeTopoEdge = 0x00005007, ComponentType::ExchangeTopoVertex = 0x00005008, ComponentType::ExchangeTopoSingleWireBody = 0x00005009,
  ComponentType::ExchangeTopoWireEdge = 0x0000500a, ComponentType::ExchangeDrawingMask = 0x00006000, ComponentType::ExchangeDrawingModel = 0x00006001, ComponentType::ExchangeDrawingView = 0x00006002,
  ComponentType::ExchangeDrawingSheet = 0x00006003, ComponentType::ExchangeBasicDrawingBlock = 0x00006004, ComponentType::ExchangeOperatorDrawingBlock = 0x00006005, ComponentType::ExchangePMIMask = 0x00009000,
  ComponentType::ExchangePMI = ExchangePMIMask, ComponentType::ExchangePMIText = 0x00009100, ComponentType::ExchangePMIRichText = 0x00009200, ComponentType::ExchangePMIRoughness = 0x00009300,
  ComponentType::ExchangePMIGDT = 0x00009400, ComponentType::ExchangePMIDatum = 0x00009500, ComponentType::ExchangePMILineWelding = 0x00009600, ComponentType::ExchangePMISpotWelding = 0x00009700,
  ComponentType::ExchangePMIDimension = 0x00009800, ComponentType::ExchangePMIBalloon = 0x00009900, ComponentType::ExchangePMICoordinate = 0x00009a00, ComponentType::ExchangePMIFastener = 0x00009b00,
  ComponentType::ExchangePMILocator = 0x00009c00, ComponentType::ExchangePMIMeasurementPoint = 0x00009d00, ComponentType::ParasolidComponentMask = 0x00010000, ComponentType::ParasolidModelFile = 0x00010001,
  ComponentType::ParasolidAssembly = 0x00010002, ComponentType::ParasolidTopologyMask = 0x00050000, ComponentType::ParasolidTopoBody = 0x00050001, ComponentType::ParasolidTopoRegion = 0x00050002,
  ComponentType::ParasolidTopoShell = 0x00050003, ComponentType::ParasolidTopoFace = 0x00050004, ComponentType::ParasolidTopoLoop = 0x00050005, ComponentType::ParasolidTopoFin = 0x00050006,
  ComponentType::ParasolidTopoEdge = 0x00050007, ComponentType::ParasolidTopoVertex = 0x00050008, ComponentType::DWGComponentMask = 0x00100000, ComponentType::DWGModelFile = 0x00100001,
  ComponentType::DWGLayout = 0x00100002, ComponentType::DWGBlockTable = 0x00100003, ComponentType::DWGBlockTableRecord = 0x00100004, ComponentType::DWGEntity = 0x00100005,
  ComponentType::DWGLayerTable = 0x00100006, ComponentType::DWGLayer = 0x00100007
}
 
- Static Public Member Functions inherited from HPS::Component
static KeyPathArray GetKeyPath (Component const &in_component)
 
static KeyPathArray GetKeyPath (size_t in_count, Component const in_components[])
 
static KeyPathArray GetKeyPath (ComponentArray const &in_components)
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The Sheet class is a user space object. It allows users to activate drawing sheets imported via Exchange.

Constructor & Destructor Documentation

HPS::Exchange::Sheet::Sheet ( )

The default constructor creates an empty Sheet object.

HPS::Exchange::Sheet::Sheet ( HPS::Component const &  in_that)

This constructor creates a Sheet 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 an Exchange::Sheet object. Otherwise the copy will fail and the resulting Exchange::Sheet will be invalid.

Parameters
in_thatThe source Component to copy.
HPS::Exchange::Sheet::Sheet ( Component const &  in_that)

This constructor creates a Sheet 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 an Exchange::Sheet object. Otherwise the copy will fail and the resulting Exchange::Sheet will be invalid.

Parameters
in_thatThe source Component to copy.
HPS::Exchange::Sheet::Sheet ( Sheet const &  in_sheet)

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

Parameters
in_sheetThe source Sheet to copy.
HPS::Exchange::Sheet::Sheet ( Sheet &&  in_that)

The move constructor creates an Sheet by transferring the underlying impl of the rvalue reference to this Sheet thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to a Sheet to take the impl from.

Member Function Documentation

bool HPS::Exchange::Sheet::Equals ( Sheet const &  in_kit) const

Check if the source Sheet is equivalent to this Sheet.

Parameters
in_kitThe source Sheet to compare to this Sheet.
Returns
true if the objects are equivalent, false otherwise.
HPS::Type HPS::Exchange::Sheet::ObjectType ( ) const
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::Exchange::Component.

bool HPS::Exchange::Sheet::operator!= ( Sheet const &  in_kit) const

Check if the source Sheet is not equivalent to this Sheet.

Parameters
in_kitThe source Sheet to compare to this Sheet.
Returns
true if the objects are not equivalent, false otherwise.
Sheet& HPS::Exchange::Sheet::operator= ( Sheet &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this Sheet thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to a Sheet to take the impl from.
Returns
A reference to this Sheet.
bool HPS::Exchange::Sheet::operator== ( Sheet const &  in_kit) const

Check if the source Sheet is equivalent to this Sheet.

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

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