Library | FileFrames | Expand

Class wfcAnnotationElement

# include <wfcAnnotation.h>

class wfcAnnotationElement
 : public virtual wfcLayerItem,
 : public virtual wfcWModelItem
{
    xaideclare(wfcAnnotationElement)
    ...
};

Description

 
Manual References:
Annotations: Annotation Features and Annotations: Redefining Annotation Features, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Baseline Dimensions


Method Summary

wfcAnnotationReferences_ptrCollectAnnotationReferences (wfcAnnotationRefFilter RefStrength, wfcAnnotationRefFromType RefSource)
LICENSE: 222
 
pfcSelections_ptrCollectQuiltReferenceSurfaces (wfcAnnotationReference_ptr QuiltReference)
 
wfcAnnotation_ptrGetAnnotation ()
LICENSE: 222
 
pfcFeature_ptrGetAnnotationFeature ()
LICENSE: 222
 
optional xstringGetAnnotationReferenceDescription (wfcAnnotationReference_ptr Reference)
LICENSE: 222
 
wfcAnnotationTypeGetAnnotationType ()
LICENSE: 222
 
xboolGetCopyFlag ()
LICENSE: 222
 
optional xboolHasMissingReferences (wfcAnnotationRefFilter ReferenceType, wfcAnnotationRefFromType ReferenceSource, xbool AtLeastOneMissingRef)
LICENSE: 222
 
xboolIsDependent ()
LICENSE: 222
 
xboolIsIncomplete ()
LICENSE: 222
 
xboolIsReadOnly ()
LICENSE: 222
 
optional xboolIsReferenceStrong (wfcAnnotationReference_ptr Reference)
LICENSE: 222
 
voidSetAnnotationReferenceDescription (wfcAnnotationReference_ptr Reference, xrstring Description)
LICENSE: 222
 

Methods Inherited from Class wfcLayerItem:

IsLayerItemVisible, RemoveNoUpdate, GetLayers, AddNoUpdate

Methods Inherited from Class pfcActionSource:

AddActionListener, RemoveActionListener, AddActionListenerWithType

Methods Inherited from Class pfcParent:

GetChild

Methods Inherited from Class pfcParameterOwner:

GetParam, CreateParam, ListParams, SelectParam, CreateParamWithUnits, SelectParameters

Methods Inherited from Class wfcWParameterOwner:

ExportParameterTable, ApplyParameterTableset

Methods Inherited from Class pfcRelationOwner:

DeleteRelations, GetRelations, SetRelations, RegenerateRelations, EvaluateExpression

Methods Inherited from Class wfcWRelationOwner:

GetRelationConstraints, UnitsUsed, UseUnits, EvaluateExpressionWithUnits

Methods Inherited from Class pfcChild:

GetDBParent, GetOId

Methods Inherited from Class pfcModelItem:

GetName, SetName, GetId, GetType

Methods Inherited from Class wfcWModelItem:

DeleteUserDefinedName, Unhide, Hide, IsHidden, IsNameReadOnly, IsZoneFeature, GetDefaultName


Method Detail

wfcAnnotationTypeGetAnnotationType ()
LICENSE: 222

 
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 


xboolIsReadOnly ()
LICENSE: 222

 
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 


optional xboolHasMissingReferences (wfcAnnotationRefFilter ReferenceType, wfcAnnotationRefFromType ReferenceSource, xbool AtLeastOneMissingRef)
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The element has no references of the given type and source.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
ReferenceType
 
ReferenceSource
 
AtLeastOneMissingRef
 
Returns:
 


xboolIsIncomplete ()
LICENSE: 222

 
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 


xboolGetCopyFlag ()
LICENSE: 222

 
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 


xboolIsDependent ()
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitCantAccess - The element is not owned by a data sharing feature.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 


wfcAnnotation_ptrGetAnnotation ()
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation element does not contain an annotation.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 


pfcFeature_ptrGetAnnotationFeature ()
LICENSE: 222

 
Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Returns:
 


optional xboolIsReferenceStrong (wfcAnnotationReference_ptr Reference)
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation element doesn't contain this reference.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
Reference
 
Returns:
 


optional xstringGetAnnotationReferenceDescription (wfcAnnotationReference_ptr Reference)
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation element doesn't contain this reference.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
Reference
 
Returns:
 


voidSetAnnotationReferenceDescription (wfcAnnotationReference_ptr Reference, xrstring Description)
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation element doesn't contain this reference.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
Reference
 
Description
 
Returns:


wfcAnnotationReferences_ptrCollectAnnotationReferences (wfcAnnotationRefFilter RefStrength, wfcAnnotationRefFromType RefSource)
LICENSE: 222

 

Exceptions thrown (but not limited to):

pfcXToolkitNotFound - The annotation element does not contain any references of the indicated type.

pfcXToolkitInvalidType - References from driving dimension annotation elements cannot be accessed.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
RefStrength
 
RefSource
 
Returns:
 


pfcSelections_ptrCollectQuiltReferenceSurfaces (wfcAnnotationReference_ptr QuiltReference)

 

Exceptions thrown (but not limited to):

pfcXToolkitInvalidType - The input reference type was not valid.


Manual References:
Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements, Annotations: Annotation Features and Annotations: Accessing and Modifying Annotation Elements
Parameters:
QuiltReference
 
Returns: