Public Member Functions | List of all members
AssemblyImprint Class Reference

AssemblyImprint Class
The commands in the AssemblyImprint class are described below.
. More...

Inherits ItemObject.

Public Member Functions

virtual void AddPropertyByReference (String &name, ReferenceObject *value)
 Adds ReferenceObject object to a specified variable. More...
 
ItemObjectGetItem (Variant &value)
 Returns an item displayed in the [Model Manager] tree such as assembly, part and sketch. Index is numbered in the order of the each items shown in the tree. More...
 
String GetName ()
 Returns a name. More...
 
virtual Variant GetProperty (String &name)
 Returns the value of the property with the specified name. More...
 
String GetScriptTypeName ()
 Returns the name of the object type as a string. More...
 
StringList GetTargetList ()
 Returns a list of solid IDs, shell IDs, or beam IDs to imprint. More...
 
double GetTolerance ()
 Returns the tolerance. More...
 
bool GetUseDefaultTol ()
 Returns whether or not to use the default tolerance. More...
 
virtual bool IsValid ()
 Returns True if an object is valid. More...
 
int NumItems ()
 Returns the number of items. More...
 
void SetName (String &name)
 Specifies a name. More...
 
virtual void SetProperty (String &name, Variant &value)
 Specifies a value of property. More...
 
virtual void SetPropertyByReference (String &name, ReferenceObject *value)
 Specifies the values in properties by ReferenceObject object. More...
 
void SetTargetList (StringList &value)
 Specifies a list of solid IDs, shell IDs, or beam IDs to imprint. More...
 
void SetTolerance (double value)
 Specifies Tolerance. More...
 
void SetUseDefaultTol (bool value)
 Specifies whether or not the default tolerance is used. More...
 

Detailed Description

AssemblyImprint Class
The commands in the AssemblyImprint class are described below.
.

The AssemblyImprint class includes the commands for the following operation.

For more information about the properties for this class, see here .

Member Function Documentation

void ItemObject::AddPropertyByReference ( String &  name,
ReferenceObject value 
)
virtualinherited

Adds ReferenceObject object to a specified variable.

Parameters
nameProperty name
valueReferenceObject object (target)
ItemObject * ItemObject::GetItem ( Variant &  value)
inherited

Returns an item displayed in the [Model Manager] tree such as assembly, part and sketch. Index is numbered in the order of the each items shown in the tree.

Parameters
valueItem name or index
Returns
ItemObject object
String ItemObject::GetName ( )
inherited

Returns a name.

Returns
Item name
Variant ItemObject::GetProperty ( String &  name)
virtualinherited

Returns the value of the property with the specified name.

Parameters
nameProperty name
Returns
Value of properties
String ItemObject::GetScriptTypeName ( )
inherited

Returns the name of the object type as a string.

Returns
Type name of object
StringList AssemblyImprint::GetTargetList ( )

Returns a list of solid IDs, shell IDs, or beam IDs to imprint.

Returns
List of solid IDs, shell IDs, or beam IDs
double AssemblyImprint::GetTolerance ( )

Returns the tolerance.

Returns
value Tolerance
bool AssemblyImprint::GetUseDefaultTol ( )

Returns whether or not to use the default tolerance.

Returns
Whether or not to use the default tolerance
bool ItemObject::IsValid ( )
virtualinherited

Returns True if an object is valid.

Returns
Whether or not the object are valid

Reimplemented in Sketch, Part, SketchItem, and MeshPart.

int ItemObject::NumItems ( )
inherited

Returns the number of items.

Returns
Item count
void ItemObject::SetName ( String &  name)
inherited

Specifies a name.

Parameters
nameItem name
void ItemObject::SetProperty ( String &  name,
Variant &  value 
)
virtualinherited

Specifies a value of property.

Parameters
nameProperty name
valueValue of properties

Reimplemented in SketchItem.

void ItemObject::SetPropertyByReference ( String &  name,
ReferenceObject value 
)
virtualinherited

Specifies the values in properties by ReferenceObject object.

Parameters
nameProperty name
valueReferenceObject object (target)
void AssemblyImprint::SetTargetList ( StringList &  value)

Specifies a list of solid IDs, shell IDs, or beam IDs to imprint.

Parameters
valueList of solid IDs, shell IDs, or beam IDs

For more information about the commands of string array type, see "Example of the String Array Type."

void AssemblyImprint::SetTolerance ( double  value)

Specifies Tolerance.

Parameters
valueTolerance
void AssemblyImprint::SetUseDefaultTol ( bool  value)

Specifies whether or not the default tolerance is used.

Parameters
value
True=on : Use the default tolerance
False=off : Do not use the default tolerance