ItemObject Class Reference

ItemObject Class
The commands in the ItemObjects class are described below.
. More...

Inherited by Assembly, AssemblyBoolean, AssemblyCircularPattern, AssemblyConstraintObject, AssemblyImprint, AssemblyLinearPattern, AssemblyMergeNode, AssemblyMirrorCopy, AssemblyScale, BuildMessage, CoilTemplate, CompositePath, EdgeChamfer, EdgeFillet, ExtrudeCut, ExtrudeImprint, ExtrudeSolid, ExtrudeSplit, ExtrudeSurface, FaceExtrudeSolid, FaceRevolveSolid, FaceSweepSolid, GeometrySet, HelixPath, ImportFeature, Imprint, MakeBeam, MeshPart, OrphanPlanarMeshFeature, OrphanVolumeMeshFeature, Part, PartBoolean, PartMergeNode, PartScale, PointsPath, ReferenceLine, ReferencePlane, ReferencePoint, RegionBoolean, RegionChamfer, RegionCircularPattern, RegionEdgeMove, RegionEdgeOffset, RegionFillet, RegionItem, RegionLinearPattern, RegionMergeNode, RegionMesh, RegionMirrorCopy, RegionMove, RegionScale, RevolveCut, RevolveSolid, RevolveSplit, RevolveSurface, SchemaAllScale, SchemaGap, Sketch, SketchCoordinateItem, SketchItem, SolidCircularPattern, SolidFaceMove, SolidFaceOffset, SolidLinearPattern, SolidMirrorCopy, SolidMove, SpiralPath, SweepCut, SweepSolid, SweepSplit, SweepSurface, UserDefinedRegionTemplate, UserDefinedSolidTemplate, VerticesPath, and WireTemplate.

Public Member Functions
virtual void	AddPropertyByReference (String &name, ReferenceObject *value)
	Adds ReferenceObject object to a specified variable. More...
ItemObject *	GetItem (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...
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...

Detailed Description

ItemObject Class
The commands in the ItemObjects class are described below.
.

The ItemObject class includes commands to perform the following operations.

• Commands used to create and copy a sketch and solid.
  
• Commands used to fillet and chamfer the geometry.
  
• Setting an assembly
  
• Commands related to create a reference line, reference plane, and reference point.
  

Member Function Documentation

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

virtual

Adds ReferenceObject object to a specified variable.

Parameters

name	Property name
value	ReferenceObject object (target)

ItemObject * ItemObject::GetItem

(

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.

Parameters

value

Item name or index

Returns

ItemObject object

String ItemObject::GetName

(

)

Returns a name.

Returns

Item name

Variant ItemObject::GetProperty ( String &  name )

virtual

Returns the value of the property with the specified name.

Parameters

name	Property name

Returns

Value of properties

String ItemObject::GetScriptTypeName

(

)

Returns the name of the object type as a string.

Returns

Type name of object

bool ItemObject::IsValid ( )

virtual

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

(

)

Returns the number of items.

Returns

Item count

void ItemObject::SetName

(

String &

name

)

Specifies a name.

Parameters

name

Item name

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

virtual

Specifies a value of property.

Parameters

name	Property name
value	Value of properties

Reimplemented in SketchItem.

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

virtual

Specifies the values in properties by ReferenceObject object.

Parameters

name	Property name
value	ReferenceObject object (target)