ON_DocumentUserStringList Class Reference

#include <opennurbs_userdata.h>

Inheritance diagram for ON_DocumentUserStringList:

Public Member Functions
	ON_DocumentUserStringList ()
	~ON_DocumentUserStringList ()
ON__UINT32	DataCRC (ON__UINT32 current_remainder) const override
void	Dump (ON_TextLog &) const override
bool	IsValid (class ON_TextLog *text_log=nullptr) const override
bool	Read (ON_BinaryArchive &binary_archive) override
bool	Write (ON_BinaryArchive &binary_archive) const override
Public Member Functions inherited from ON_Object
	ON_Object () ON_NOEXCEPT
	ON_Object (const ON_Object &)
virtual	~ON_Object ()
virtual ON_AggregateComponentStatus	AggregateComponentStatus () const
bool	AttachUserData (class ON_UserData *pUserData)
unsigned int	ClearAllComponentStates () const
virtual unsigned int	ClearComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_clear) const
virtual unsigned int	ClearComponentStates (ON_ComponentStatus states_to_clear) const
void	CopyUserData (const ON_Object &source_object)
unsigned int	CopyUserData (const ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution)
virtual bool	DeleteComponents (const ON_COMPONENT_INDEX *ci_list, size_t ci_count)
virtual void	DestroyRuntimeCache (bool bDelete=true)
bool	DetachUserData (class ON_UserData *pUserData)
void	EmergencyDestroy ()
class ON_UserData *	FirstUserData () const
virtual unsigned int	GetComponentsWithSetStates (ON_ComponentStatus states_filter, bool bAllEqualStates, ON_SimpleArray< ON_COMPONENT_INDEX > &components) const
class ON_UserData *	GetUserData (const ON_UUID &userdata_uuid) const
bool	GetUserString (const wchar_t *key, ON_wString &string_value) const
int	GetUserStringKeys (ON_ClassArray< ON_wString > &user_string_keys) const
int	GetUserStrings (ON_ClassArray< ON_UserString > &user_strings) const
bool	IsCorrupt (bool bRepair, bool bSilentError, class ON_TextLog *text_log) const
bool	IsKindOf (const ON_ClassId *pClassId) const
virtual void	MarkAggregateComponentStatusAsNotCurrent () const
virtual void	MemoryRelocate ()
virtual ON_UUID	ModelObjectId () const
void	MoveUserData (ON_Object &source_object)
unsigned int	MoveUserData (ON_Object &source_object, ON_UUID source_userdata_item_id, ON_Object::UserDataConflictResolution userdata_conflict_resolution, bool bDeleteAllSourceItems)
virtual ON::object_type	ObjectType () const
ON_Object &	operator= (const ON_Object &)
void	PurgeUserData ()
virtual unsigned int	SetComponentStates (ON_COMPONENT_INDEX component_index, ON_ComponentStatus states_to_set) const
virtual unsigned int	SetComponentStatus (ON_COMPONENT_INDEX component_index, ON_ComponentStatus status_to_copy) const
bool	SetUserString (const wchar_t *key, const wchar_t *string_value)
int	SetUserStrings (int count, const ON_UserString *user_strings, bool bReplace)
virtual unsigned int	SizeOf () const
bool	ThisIsNullptr (bool bSilentError) const
void	TransformUserData (const class ON_Xform &xform)
virtual bool	UpdateReferencedComponents (const class ON_ComponentManifest &source_manifest, const class ON_ComponentManifest &destination_manifest, const class ON_ManifestMap &manifest_map)
int	UserStringCount () const

Additional Inherited Members
Public Types inherited from ON_Object
enum	UserDataConflictResolution : unsigned char {   UserDataConflictResolution::destination_object = 0, UserDataConflictResolution::source_object = 1, UserDataConflictResolution::source_copycount_gt = 2, UserDataConflictResolution::source_copycount_ge = 3,   UserDataConflictResolution::destination_copycount_gt = 4, UserDataConflictResolution::destination_copycount_ge = 5, UserDataConflictResolution::delete_item = 6 }

Detailed Description

Description: An ON_DocumentUserStringList object is saved in the list of user tables. The Rhino SetDocumentText and GetDocumentText commands use the ON_Object SetUserString, GetUserString, GetUserStrings, GetUserStringKeys functions on an ON_DocumentUserStringList class to manage the tag-value pairs of strings.

Constructor & Destructor Documentation

ON_DocumentUserStringList()

ON_DocumentUserStringList::ON_DocumentUserStringList

(

)

~ON_DocumentUserStringList()

ON_DocumentUserStringList::~ON_DocumentUserStringList

(

)

Member Function Documentation

DataCRC()

ON__UINT32 ON_DocumentUserStringList::DataCRC ( ON__UINT32  current_remainder ) const

overridevirtual

Description: Returns a CRC calculated from the information that defines the object. This CRC can be used as a quick way to see if two objects are not identical. Parameters: current_remainder - [in]; Returns: CRC of the information the defines the object.

Reimplemented from ON_Object.

Dump()

void ON_DocumentUserStringList::Dump ( ON_TextLog &  ) const

overridevirtual

Description: Creates a text dump of the object. Remarks: Dump() is intended for debugging and is not suitable for creating high quality text descriptions of an object.

The default implementations of this virtual function prints the class's name.

Reimplemented from ON_Object.

IsValid()

bool ON_DocumentUserStringList::IsValid ( class ON_TextLog *  text_log = nullptr ) const

overridevirtual

Description: Tests an object to see if its data members are correctly initialized. Parameters: text_log - [in] if the object is not valid and text_log is not nullptr, then a brief englis description of the reason the object is not valid is appened to the log. The information appended to text_log is suitable for low-level debugging purposes by programmers and is not intended to be useful as a high level user interface tool. Returns: @untitled table true object is valid false object is invalid, uninitialized, etc.

Reimplemented from ON_Object.

Read()

bool ON_DocumentUserStringList::Read ( ON_BinaryArchive &  binary_archive )

overridevirtual

Description: Low level archive writing tool used by ON_BinaryArchive::ReadObject(). Parameters: binary_archive - archive to read from Returns: Returns true if the read is successful. Remarks: Use ON_BinaryArchive::ReadObject() to read objects. This Read() function should read the objects definition back into its data members.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.

Write()

bool ON_DocumentUserStringList::Write ( ON_BinaryArchive &  binary_archive ) const

overridevirtual

Description: Low level archive writing tool used by ON_BinaryArchive::WriteObject(). Parameters: binary_archive - archive to write to Returns: Returns true if the write is successful. Remarks: Use ON_BinaryArchive::WriteObject() to write objects. This Write() function should just write the specific definition of this object. It should not write and any chunk typecode or length information.

The default implementation of this virtual function returns false and does nothing.

Reimplemented from ON_Object.