NXOpen::CAE::NoteManager Class Reference

Represents an object that manages annotation for CAE
To obtain an instance of this class, refer to NXOpen::CAE::CaePart

Created in NX12.0.0. More...

Inheritance diagram for NXOpen::CAE::NoteManager:

Classes
class	iterator
	Iterator for accessing the contents of the collection. More...

Public Types
enum	FolderType { FolderTypeNew, FolderTypeExisting }
	Select folder for new note. More...

Public Member Functions
iterator	begin ()
	Returns an iterator addressing the first element. More...
NXOpen::CAE::CaeNoteBuilder *	CreateCaeNoteBuilder (NXOpen::Annotations::SimpleDraftingAid *annotation)
	Creates a builder for cae annotation command. More...
NXOpen::CAE::NoteFolder *	CreateNoteFolder (const NXString &folderName)
	Creates a folder for cae annotation. More...
NXOpen::CAE::NoteFolder *	CreateNoteFolder (const char *folderName)
	Creates a folder for cae annotation. More...
void	DeleteFolder (NXOpen::CAE::NoteFolder *folder)
	Delete specified folder Created in NX12.0.0. More...
iterator	end ()
	Returns an iterator addressing one past the last element. More...
NXOpen::TaggedObject *	GetFolderOfAnnotation (NXOpen::Annotations::NoteBase *annotation)
	Gets Folder of an existing annotation. More...
void	MoveNotesToFolder (NXOpen::CAE::NoteFolder *folder, const std::vector< NXOpen::Annotations::NoteBase * > &annotation)
	Move notes to specified folder Created in NX12.0.0. More...
void	RenameFolder (NXOpen::CAE::NoteFolder *folder, const NXString &folderName)
	Rename specified folder Created in NX12.0.0. More...
void	RenameFolder (NXOpen::CAE::NoteFolder *folder, const char *folderName)
	Rename specified folder Created in NX12.0.0. More...
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents an object that manages annotation for CAE
To obtain an instance of this class, refer to NXOpen::CAE::CaePart

Created in NX12.0.0.

Member Enumeration Documentation

enum NXOpen::CAE::NoteManager::FolderType

Select folder for new note.

Enumerator
FolderTypeNew	Create new folder.
FolderTypeExisting	Add to Existing folder.

Member Function Documentation

iterator NXOpen::CAE::NoteManager::begin

(

)

Returns an iterator addressing the first element.

NXOpen::CAE::CaeNoteBuilder* NXOpen::CAE::NoteManager::CreateCaeNoteBuilder

(

NXOpen::Annotations::SimpleDraftingAid *

annotation

)

Creates a builder for cae annotation command.

Returns

Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

annotation

NXOpen::Annotations::SimpleDraftingAid to be edited

NXOpen::CAE::NoteFolder* NXOpen::CAE::NoteManager::CreateNoteFolder

(

const NXString &

folderName

)

Creates a folder for cae annotation.

Returns

Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folderName

foldername

NXOpen::CAE::NoteFolder* NXOpen::CAE::NoteManager::CreateNoteFolder

(

const char *

folderName

)

Creates a folder for cae annotation.

Returns

Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folderName

foldername

void NXOpen::CAE::NoteManager::DeleteFolder

(

NXOpen::CAE::NoteFolder *

folder

)

Delete specified folder
Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folder

folder

iterator NXOpen::CAE::NoteManager::end

(

)

Returns an iterator addressing one past the last element.

NXOpen::TaggedObject* NXOpen::CAE::NoteManager::GetFolderOfAnnotation

(

NXOpen::Annotations::NoteBase *

annotation

)

Gets Folder of an existing annotation.

Returns

Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

annotation

annotation

void NXOpen::CAE::NoteManager::MoveNotesToFolder	(	NXOpen::CAE::NoteFolder *	folder,
		const std::vector< NXOpen::Annotations::NoteBase * > &	annotation
	)

Move notes to specified folder
Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folder	folder
annotation	annotation

void NXOpen::CAE::NoteManager::RenameFolder	(	NXOpen::CAE::NoteFolder *	folder,
		const NXString &	folderName
	)

Rename specified folder
Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folder	folder
folderName	foldername

void NXOpen::CAE::NoteManager::RenameFolder	(	NXOpen::CAE::NoteFolder *	folder,
		const char *	folderName
	)

Rename specified folder
Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folder	folder
folderName	foldername

tag_t NXOpen::CAE::NoteManager::Tag

(

)

const

Returns the tag of this object.

---

The documentation for this class was generated from the following file:

• CAE_NoteManager.hxx