NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::AME::DB::DocumentStructure Class Reference

Class to define Document Structure object
This object does not need a creator. More...

Inheritance diagram for NXOpen::AME::DB::DocumentStructure:
NXOpen::TaggedObject

Public Types

enum  Attribute {
  AttributeNone, AttributeFunction, AttributeLocation, AttributeProduct,
  AttributeDcc
}
 Represents the attribute for Document Structure. More...
 

Public Member Functions

NXString GetClassificationCode ()
 Get the Classification Code. More...
 
NXString GetDocumentStructureString ()
 Get the Document Structure string from Document Structur object. More...
 
void SetClassificationCode (const NXString &dccString)
 Set the Classification Code. More...
 
void SetClassificationCode (const char *dccString)
 Set the Classification Code. More...
 
void SetDocumentStructure (NXOpen::AME::DB::DocumentStructure::Attribute firstAttr, NXOpen::AME::DB::DocumentStructure::Attribute secondAttr, NXOpen::AME::DB::DocumentStructure::Attribute thirdAttr, NXOpen::AME::DB::DocumentStructure::Attribute fourthAttr)
 Set all four attributes of Document Structure order in sequence. More...
 
void SetDocumentStructure (NXOpen::AME::DB::DocumentStructure::Attribute firstAttr, NXOpen::AME::DB::DocumentStructure::Attribute secondAttr, NXOpen::AME::DB::DocumentStructure::Attribute thirdAttr)
 Set any three attributes of Document Structure order in sequence
Created in NX11.0.0. More...
 
void SetDocumentStructure (NXOpen::AME::DB::DocumentStructure::Attribute firstAttr, NXOpen::AME::DB::DocumentStructure::Attribute secondAttr)
 Set any two attributes of Document Structure order in sequence. More...
 
void SetDocumentStructure (NXOpen::AME::DB::DocumentStructure::Attribute firstAttr)
 Set any one attribute of Document Structure order. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Class to define Document Structure object
This object does not need a creator.



Created in NX11.0.0.

Member Enumeration Documentation

Represents the attribute for Document Structure.

Enumerator
AttributeNone 

none

AttributeFunction 

function

AttributeLocation 

location

AttributeProduct 

product

AttributeDcc 

dcc

Member Function Documentation

NXString NXOpen::AME::DB::DocumentStructure::GetClassificationCode ( )

Get the Classification Code.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
NXString NXOpen::AME::DB::DocumentStructure::GetDocumentStructureString ( )

Get the Document Structure string from Document Structur object.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")
void NXOpen::AME::DB::DocumentStructure::SetClassificationCode ( const NXString dccString)

Set the Classification Code.


Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
dccStringdccstring
void NXOpen::AME::DB::DocumentStructure::SetClassificationCode ( const char *  dccString)

Set the Classification Code.


Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
dccStringdccstring
void NXOpen::AME::DB::DocumentStructure::SetDocumentStructure ( NXOpen::AME::DB::DocumentStructure::Attribute  firstAttr,
NXOpen::AME::DB::DocumentStructure::Attribute  secondAttr,
NXOpen::AME::DB::DocumentStructure::Attribute  thirdAttr,
NXOpen::AME::DB::DocumentStructure::Attribute  fourthAttr 
)

Set all four attributes of Document Structure order in sequence.


Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
firstAttrfirstattr
secondAttrsecondattr
thirdAttrthirdattr
fourthAttrfourthattr
void NXOpen::AME::DB::DocumentStructure::SetDocumentStructure ( NXOpen::AME::DB::DocumentStructure::Attribute  firstAttr,
NXOpen::AME::DB::DocumentStructure::Attribute  secondAttr,
NXOpen::AME::DB::DocumentStructure::Attribute  thirdAttr 
)

Set any three attributes of Document Structure order in sequence
Created in NX11.0.0.



License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
firstAttrfirstattr
secondAttrsecondattr
thirdAttrthirdattr
void NXOpen::AME::DB::DocumentStructure::SetDocumentStructure ( NXOpen::AME::DB::DocumentStructure::Attribute  firstAttr,
NXOpen::AME::DB::DocumentStructure::Attribute  secondAttr 
)

Set any two attributes of Document Structure order in sequence.


Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
firstAttrfirstattr
secondAttrsecondattr
void NXOpen::AME::DB::DocumentStructure::SetDocumentStructure ( NXOpen::AME::DB::DocumentStructure::Attribute  firstAttr)

Set any one attribute of Document Structure order.


Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters
firstAttrfirstattr

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.