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 Member Functions
void	AttachObjectsWithNote (NXOpen::TaggedObject note, const std::vector< NXOpen::TaggedObject > &objectArray)
	Attach objects with annotation Created in NX1847.0.0. More...

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 Created in NX12.0.0. More...

NXOpen::CAE::CaeNote *	CreateNote (std::vector< NXString > &lines, const NXOpen::Point3d &origin, int font, int fontColor, int fontSize, NXOpen::CAE::Plane planeType, const NXString &folderName)
	Create annotation with given settings Created in NX1847.0.0. More...

NXOpen::CAE::CaeNote *	CreateNote (std::vector< NXString > &lines, const NXOpen::Point3d &origin, int font, int fontColor, int fontSize, NXOpen::CAE::Plane planeType, const char *folderName)
	Create annotation with given settings Created in NX1847.0.0. More...

NXOpen::CAE::NoteFolder *	CreateNoteFolder (const NXString &folderName)
	Creates a folder for cae annotation Created in NX12.0.0. More...

NXOpen::CAE::NoteFolder *	CreateNoteFolder (const char *folderName)
	Creates a folder for cae annotation Created in NX12.0.0. More...

NXOpen::CAE::NotePreferencesBuilder *	CreateNotePreferencesBuilder ()
	Creates a builder for note preferences command Created in NX1847.0.0. More...

void	DeleteFolder (NXOpen::CAE::NoteFolder *folder)
	Delete specified folder Created in NX12.0.0. More...

void	DetachObjectsWithNote (NXOpen::TaggedObject *note)
	Detach objects with annotation Created in NX1847.0.0. More...

iterator	end ()
	Returns an iterator addressing one past the last element. More...

void	FindNotesWithSubtext (const NXString &findStr, std::vector< NXOpen::TaggedObject * > &noteArray)
	Gets all the annotations which contain the given text Created in NX1847.0.0. More...

void	FindNotesWithSubtext (const char findStr, std::vector< NXOpen::TaggedObject > &noteArray)
	Gets all the annotations which contain the given text Created in NX1847.0.0. More...

void	FindNotesWithText (const NXString &findStr, std::vector< NXOpen::TaggedObject * > &noteArray)
	Gets all the annotations with a given text Created in NX1847.0.0. More...

void	FindNotesWithText (const char findStr, std::vector< NXOpen::TaggedObject > &noteArray)
	Gets all the annotations with a given text Created in NX1847.0.0. More...

void	GetAllNotes (std::vector< NXOpen::TaggedObject * > &noteArray)
	Gets all the annotations of a part Created in NX1847.0.0. More...

void	GetAllNotesOfFolder (const NXString &folderName, std::vector< NXOpen::TaggedObject * > &noteArray)
	Gets all the annotations of a folder Created in NX1847.0.0. More...

void	GetAllNotesOfFolder (const char folderName, std::vector< NXOpen::TaggedObject > &noteArray)
	Gets all the annotations of a folder Created in NX1847.0.0. More...

bool	GetDisplayStatus (NXOpen::TaggedObject *notes)
	Get display status of annotation. More...

NXOpen::TaggedObject *	GetFolderOfAnnotation (NXOpen::Annotations::NoteBase *annotation)
	Gets Folder of an existing annotation Created in NX12.0.0. More...

void	HideNotes (const std::vector< NXOpen::TaggedObject * > &noteArray)
	Hide annotations Created in NX1847.0.0. 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...

void	SetOrigin (NXOpen::TaggedObject *note, const NXOpen::Point3d &origin)
	Move annotation to a new location Created in NX1847.0.0. More...

void	SetParallelToScreen (bool parallelToScreen, const std::vector< NXOpen::CAE::CaeNote * > &annotations)
	Sets the parallel to screen status on each input annotation. More...

void	SetText (NXOpen::TaggedObject *note, std::vector< NXString > &lines)
	Set new text in annotation Created in NX1847.0.0. More...

void	ShowNotes (const std::vector< NXOpen::TaggedObject * > &noteArray)
	Display hidden annotations Created in NX1847.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 Function Documentation

void NXOpen::CAE::NoteManager::AttachObjectsWithNote	(	NXOpen::TaggedObject *	note,
		const std::vector< NXOpen::TaggedObject * > &	objectArray
	)

Attach objects with annotation
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

note	note
objectArray	Array of objects

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
Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

annotation NXOpen::Annotations::SimpleDraftingAid to be edited

NXOpen::CAE::CaeNote* NXOpen::CAE::NoteManager::CreateNote	(	std::vector< NXString > &	lines,
		const NXOpen::Point3d &	origin,
		int	font,
		int	fontColor,
		int	fontSize,
		NXOpen::CAE::Plane	planeType,
		const NXString &	folderName
	)

Create annotation with given settings
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

lines	List of text
origin	origin
font	font
fontColor	fontcolor
fontSize	fontsize
planeType	plane type
folderName	foldername

NXOpen::CAE::CaeNote* NXOpen::CAE::NoteManager::CreateNote	(	std::vector< NXString > &	lines,
		const NXOpen::Point3d &	origin,
		int	font,
		int	fontColor,
		int	fontSize,
		NXOpen::CAE::Plane	planeType,
		const char *	folderName
	)

Create annotation with given settings
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

lines	List of text
origin	origin
font	font
fontColor	fontcolor
fontSize	fontsize
planeType	plane type
folderName	foldername

NXOpen::CAE::NoteFolder* NXOpen::CAE::NoteManager::CreateNoteFolder ( const NXString & folderName )

Creates a folder for cae annotation
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
Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folderName foldername

NXOpen::CAE::NotePreferencesBuilder* NXOpen::CAE::NoteManager::CreateNotePreferencesBuilder ( )

Creates a builder for note preferences command
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

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

void NXOpen::CAE::NoteManager::DetachObjectsWithNote ( NXOpen::TaggedObject * note )

Detach objects with annotation
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

note note

iterator NXOpen::CAE::NoteManager::end ( )

Returns an iterator addressing one past the last element.

void NXOpen::CAE::NoteManager::FindNotesWithSubtext	(	const NXString &	findStr,
		std::vector< NXOpen::TaggedObject * > &	noteArray
	)

Gets all the annotations which contain the given text
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

findStr	find str
noteArray	Array of annotations

void NXOpen::CAE::NoteManager::FindNotesWithSubtext	(	const char *	findStr,
		std::vector< NXOpen::TaggedObject * > &	noteArray
	)

Gets all the annotations which contain the given text
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

findStr	find str
noteArray	Array of annotations

void NXOpen::CAE::NoteManager::FindNotesWithText	(	const NXString &	findStr,
		std::vector< NXOpen::TaggedObject * > &	noteArray
	)

Gets all the annotations with a given text
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

findStr	find str
noteArray	Array of annotations

void NXOpen::CAE::NoteManager::FindNotesWithText	(	const char *	findStr,
		std::vector< NXOpen::TaggedObject * > &	noteArray
	)

Gets all the annotations with a given text
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

findStr	find str
noteArray	Array of annotations

void NXOpen::CAE::NoteManager::GetAllNotes ( std::vector< NXOpen::TaggedObject * > & noteArray )

Gets all the annotations of a part
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

noteArray Array of annotations

void NXOpen::CAE::NoteManager::GetAllNotesOfFolder	(	const NXString &	folderName,
		std::vector< NXOpen::TaggedObject * > &	noteArray
	)

Gets all the annotations of a folder
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folderName	foldername
noteArray	Array of annotations

void NXOpen::CAE::NoteManager::GetAllNotesOfFolder	(	const char *	folderName,
		std::vector< NXOpen::TaggedObject * > &	noteArray
	)

Gets all the annotations of a folder
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

folderName	foldername
noteArray	Array of annotations

bool NXOpen::CAE::NoteManager::GetDisplayStatus ( NXOpen::TaggedObject * notes )

Get display status of annotation.

Returns: Array of notes
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

notes notes

NXOpen::TaggedObject* NXOpen::CAE::NoteManager::GetFolderOfAnnotation ( NXOpen::Annotations::NoteBase * annotation )

Gets Folder of an existing annotation
Created in NX12.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

annotation annotation

void NXOpen::CAE::NoteManager::HideNotes ( const std::vector< NXOpen::TaggedObject * > & noteArray )

Hide annotations
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

noteArray Array of notes

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

void NXOpen::CAE::NoteManager::SetOrigin	(	NXOpen::TaggedObject *	note,
		const NXOpen::Point3d &	origin
	)

Move annotation to a new location
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

note	note
origin	origin

void NXOpen::CAE::NoteManager::SetParallelToScreen	(	bool	parallelToScreen,
		const std::vector< NXOpen::CAE::CaeNote * > &	annotations
	)

Sets the parallel to screen status on each input annotation.

Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

parallelToScreen	Parallel to Screen Setting
annotations	Annotations to be set

void NXOpen::CAE::NoteManager::SetText	(	NXOpen::TaggedObject *	note,
		std::vector< NXString > &	lines
	)

Set new text in annotation
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

note	note
lines	lines

void NXOpen::CAE::NoteManager::ShowNotes ( const std::vector< NXOpen::TaggedObject * > & noteArray )

Display hidden annotations
Created in NX1847.0.0.

License requirements : nx_masterfem ("Finite Element Modeling")

Parameters

noteArray Array of notes

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

Classes

Public Member Functions

Detailed Description

Member Function Documentation