Dtk_OverrideSet Class Reference

This is the Override Set Class.
The Dtk_OverrideSetPtr object is used as override set into an assembly tree.
. More...

Inheritance diagram for Dtk_OverrideSet:

Public Types
enum	SemanticType {   DefaultType = 0, SW_Configuration, SW_Explosion, NX_Arrangement,   NX_Explosion, CatiaV5_Scene, CatiaV6_Scene, SE_DisplayConfiguration,   SE_ExplodedView, CREO_Explosion, INV_ModelState }

Public Member Functions
Dtk_ErrorStatus	AddOverrideInfoOnComponent (Dtk_OverrideInfoPtr inOverrideInfo)
Dtk_ErrorStatus	AddOverrideInfoOnNode (Dtk_OverrideInfoPtr inOverrideInfo)
Dtk_ErrorStatus	ClearVolatileInfos ()
	Clear Volatile Override Infos. More...
	Dtk_OverrideSet (const Dtk_OverrideSet &inToBeCopied)
Dtk_Int32	DtkDynamicType (const int &inId)
	Retrieves the dynamic entity type. More...
virtual void	dump (FILE *file=stdout)
Dtk_tab< Dtk_NodeConnectorPtr > const &	GetConnectors () const
	Retrieves the connectors to the component or entities affected by override. More...
const Dtk_string &	GetName () const
	Retrieves the name . More...
Dtk_tab< Dtk_OverrideInfoPtr > const &	GetOverrideInfoListOnComponent () const
	Retrieves the overrides. More...
Dtk_tab< Dtk_OverrideInfoPtr > const &	GetOverrideInfoListOnNode () const
SemanticType	GetSemanticType () const
	Retrieves Semantic Type in the original software. More...
virtual Dtk_Size_t	GetSize () const
const Dtk_string &	GetTargetName () const
	Retrieves the target name. More...
Dtk_bool	IsActivated ()
	Ge. More...
void	SetActivated (Dtk_bool inActivationFlag)
Dtk_ErrorStatus	SetConnectors (Dtk_tab< Dtk_NodeConnectorPtr > inConnectedEntities)
	Set the connectors to the component or entities affected by override. More...
Dtk_ErrorStatus	SetOverrideInfoListOnComponent (Dtk_tab< Dtk_OverrideInfoPtr > inOverrideInfoList)
	Set the connectors to the component or entities affected by override. More...
Dtk_ErrorStatus	SetOverrideInfoListOnNode (Dtk_tab< Dtk_OverrideInfoPtr > inOverrideInfoList)

Static Public Member Functions
static Dtk_OverrideSetPtr	Create (Dtk_string inName, SemanticType inType=DefaultType, Dtk_string inTargetName=Dtk_string())
static Dtk_string	Dtk_OverrideSetEnumToString (const SemanticType &inEnum)
static Dtk_OverrideSet *	DtkDynamicCast (Dtk_Object *s)
	Performs a dynamic cast - doesn't need RTTI -. More...

Protected Types
enum	{ _typeID = DTK_TYPE_OBJECT }
enum	{ _typeID = DTK_TYPE_OVERRIDE_SET }

Protected Attributes
Dtk_Handle *	_Private
unsigned long	count_

Detailed Description

This is the Override Set Class.
The Dtk_OverrideSetPtr object is used as override set into an assembly tree.
.

See also

Use Dtk_OverrideSet class to handle it.

Member Enumeration Documentation

anonymous enum

anonymous enum

protectedinherited

Enumerator
_typeID

{ _typeID = DTK_TYPE_OBJECT }; 

anonymous enum

anonymous enum

protected

Enumerator
_typeID

{ _typeID = DTK_TYPE_OVERRIDE_SET };

SemanticType

enum Dtk_OverrideSet::SemanticType

Enumerator
DefaultType
SW_Configuration
SW_Explosion
NX_Arrangement
NX_Explosion
CatiaV5_Scene
CatiaV6_Scene
SE_DisplayConfiguration
SE_ExplodedView
CREO_Explosion
INV_ModelState

     {
          DefaultType = 0,
          // [SOLIDWORKS]
          SW_Configuration,
          SW_Explosion,
          // [NX]
          NX_Arrangement,
          NX_Explosion,
          // [Catia V5]
          CatiaV5_Scene,
          // [Catia V6]
          CatiaV6_Scene,
          // [Solid Edge]
          SE_DisplayConfiguration,
          SE_ExplodedView,
          // [Creo]
          CREO_Explosion,
          // [Inventor]
          INV_ModelState
     };

Constructor & Destructor Documentation

Dtk_OverrideSet()

Dtk_OverrideSet::Dtk_OverrideSet

(

const Dtk_OverrideSet &

inToBeCopied

)

Member Function Documentation

AddOverrideInfoOnComponent()

Dtk_ErrorStatus Dtk_OverrideSet::AddOverrideInfoOnComponent

(

Dtk_OverrideInfoPtr

inOverrideInfo

)

AddOverrideInfoOnNode()

Dtk_ErrorStatus Dtk_OverrideSet::AddOverrideInfoOnNode

(

Dtk_OverrideInfoPtr

inOverrideInfo

)

ClearVolatileInfos()

Dtk_ErrorStatus Dtk_OverrideSet::ClearVolatileInfos

(

)

Clear Volatile Override Infos.

Returns

dtkNoError if ok.

Create()

static Dtk_OverrideSetPtr Dtk_OverrideSet::Create ( Dtk_string  inName, SemanticType  inType = DefaultType, Dtk_string  inTargetName = Dtk_string()  )

static

Dtk_OverrideSetEnumToString()

static Dtk_string Dtk_OverrideSet::Dtk_OverrideSetEnumToString ( const SemanticType &  inEnum )

static

     {
          switch (inEnum)
          {
          case DefaultType: return L"DefaultType";
          case SW_Configuration: return L"SW_Configuration";
          case SW_Explosion: return L"SW_Explosion";
          case NX_Arrangement: return L"NX_Arrangement";
          case NX_Explosion: return L"NX_Explosion";
          case CatiaV5_Scene: return L"CatiaV5_Scene";
          case CatiaV6_Scene: return L"CatiaV6_Scene";
          case SE_DisplayConfiguration: return L"SE_DisplayConfiguration";
          case SE_ExplodedView: return L"SE_ExplodedView";
          case CREO_Explosion: return L"CREO_Explosion";
          case INV_ModelState: return L"INV_ModelState";
          default: return L"Unknown";
          }
     }

DtkDynamicCast()

static Dtk_OverrideSet* Dtk_OverrideSet::DtkDynamicCast ( Dtk_Object *  s )

static

Performs a dynamic cast - doesn't need RTTI -.

DtkDynamicType()

Dtk_Int32 Dtk_OverrideSet::DtkDynamicType ( const int &  inId )

virtual

Retrieves the dynamic entity type.

Implements Dtk_Object.

dump()

virtual void Dtk_Object::dump ( FILE *  file = stdout )

virtualinherited

GetConnectors()

Dtk_tab<Dtk_NodeConnectorPtr> const& Dtk_OverrideSet::GetConnectors

(

)

const

Retrieves the connectors to the component or entities affected by override.

Returns

the connectors.

GetName()

const Dtk_string& Dtk_OverrideSet::GetName

(

)

const

Retrieves the name .

Returns

the name if succeeds, empty string otherwise.

GetOverrideInfoListOnComponent()

Dtk_tab<Dtk_OverrideInfoPtr> const& Dtk_OverrideSet::GetOverrideInfoListOnComponent

(

)

const

Retrieves the overrides.

Returns

the overrides.

GetOverrideInfoListOnNode()

Dtk_tab<Dtk_OverrideInfoPtr> const& Dtk_OverrideSet::GetOverrideInfoListOnNode

(

)

const

GetSemanticType()

SemanticType Dtk_OverrideSet::GetSemanticType

(

)

const

Retrieves Semantic Type in the original software.

Returns

type of information stored in the original software.

GetSize()

virtual Dtk_Size_t Dtk_Object::GetSize ( ) const

virtualinherited

Reimplemented in Dtk_Shell, Dtk_Body, Dtk_Lump, Dtk_Volume, Dtk_Face, Dtk_Loop, Dtk_Coedge, Dtk_Edge, Dtk_Vertex, Dtk_mesh_face, Dtk_mesh, Dtk_TransformedSurface, Dtk_FilletSurface, Dtk_OffsetSurface, Dtk_SphericalSurface, Dtk_ToroidalSurface, Dtk_ConicalSurface, Dtk_CylindricalSurface, Dtk_RuledSurface, Dtk_LinearExtrusionSurface, Dtk_StandardRevolutionSurface, Dtk_RevolutionSurface, Dtk_PlaneSurface, Dtk_NurbsSurface, Dtk_Surface, Dtk_Hyperbola, Dtk_Parabola, Dtk_Ellipse, Dtk_Conic, Dtk_Line, Dtk_Polyline, Dtk_NurbsCurve, Dtk_Curve, Dtk_Point, Dtk_Entity, and Dtk_Info.

GetTargetName()

const Dtk_string& Dtk_OverrideSet::GetTargetName

(

)

const

Retrieves the target name.

Returns

the target name if succeeds, empty string otherwise.

IsActivated()

Dtk_bool Dtk_OverrideSet::IsActivated

(

)

Ge.

Returns

DTK_TRUE if this override set is activated, DTK_FALSE otherwise.

SetActivated()

void Dtk_OverrideSet::SetActivated

(

Dtk_bool

inActivationFlag

)

SetConnectors()

Dtk_ErrorStatus Dtk_OverrideSet::SetConnectors

(

Dtk_tab< Dtk_NodeConnectorPtr >

inConnectedEntities

)

Set the connectors to the component or entities affected by override.

Returns

dtkNoError if ok.

SetOverrideInfoListOnComponent()

Dtk_ErrorStatus Dtk_OverrideSet::SetOverrideInfoListOnComponent

(

Dtk_tab< Dtk_OverrideInfoPtr >

inOverrideInfoList

)

Set the connectors to the component or entities affected by override.

Returns

dtkNoError if ok.

SetOverrideInfoListOnNode()

Dtk_ErrorStatus Dtk_OverrideSet::SetOverrideInfoListOnNode

(

Dtk_tab< Dtk_OverrideInfoPtr >

inOverrideInfoList

)

Field Documentation

_Private

Dtk_Handle* Dtk_OverrideSet::_Private

protected

count_

unsigned long Dtk_Object::count_

protectedinherited