#include <opennurbs_embedded_file.h>

Inheritance diagram for ON_EmbeddedFile:

Public Member Functions
	ON_EmbeddedFile ()

	ON_EmbeddedFile (const ON_EmbeddedFile &)

virtual	~ON_EmbeddedFile ()

virtual bool	Clear (void)
	Clears the embedded file data. Returns true if successful, else false. More...

virtual size_t	CompressedLength (void) const

bool	Error (void) const

virtual void *	EVF (const wchar_t func, void data)
	Emergency virtual function for future expansion. More...

virtual ON_wString	Filename (void) const

virtual size_t	Length (void) const
	Returns the length of the loaded data. If the object is not loaded, this method returns zero. More...

virtual bool	LoadFromBuffer (ON_Buffer &buf)

virtual bool	LoadFromFile (const wchar_t *filename)
	Loads the embedded file from a local file. This also sets the filename. Returns true if successful, else false. More...

virtual const ON_EmbeddedFile &	operator= (const ON_EmbeddedFile &)

virtual bool	Read (ON_BinaryArchive &archive) override

virtual bool	SaveToBuffer (ON_Buffer &buf) const

virtual bool	SaveToFile (const wchar_t *filename) const

virtual void	SetFilename (const wchar_t *filename)

virtual bool	Write (ON_BinaryArchive &archive) const override

Public Member Functions inherited from ON_ModelComponent
	ON_ModelComponent () ON_NOEXCEPT

	ON_ModelComponent (const ON_ModelComponent &source)

	ON_ModelComponent (ON_ModelComponent::Type component_type) ON_NOEXCEPT

	ON_ModelComponent (ON_ModelComponent::Type component_type, const ON_ModelComponent &source) ON_NOEXCEPT
	Locked status of source attributes is not copied to permit copy and modify operations. More...

	~ON_ModelComponent ()=default

bool	ChangeName (const wchar_t new_name, class ON_ComponentManifest manifest)

bool	ClearComponentType ()

bool	ClearId ()

bool	ClearIndex ()

unsigned int	ClearModelComponentAttributes (unsigned int attributes_filter)

bool	ClearModelComponentStatus ()

bool	ClearModelSerialNumber ()

bool	ClearName ()

bool	ClearParentId ()

int	CompareName (const ON_UUID &other_parent_id, const wchar_t *other_name) const

int	CompareName (const wchar_t *other_name) const

int	CompareNameExact (const ON_UUID &other_parent_id, const wchar_t *other_name) const

int	CompareNameExact (const wchar_t *other_name) const

ON_ModelComponent::Type	ComponentType () const

bool	ComponentTypeIsLocked () const

bool	ComponentTypeIsSet () const

ON__UINT64	ContentVersionNumber () const

unsigned int	CopyFrom (const ON_ModelComponent &src, unsigned int attributes_filter)

ON__UINT32	DataCRC (ON__UINT32 current_remainder) const override

const ON_wString	DeletedName () const

const ON_NameHash &	DeletedNameHash () const

bool	DeletedNameIsSet () const

bool	DeleteName ()

void	Dump (ON_TextLog &) const override

bool	EraseIdentification (bool bIgnoreLocks)

const wchar_t *	GetName (ON_wString &component_name) const

const ON_UUID &	Id () const

bool	IdIsLocked () const

bool	IdIsNil () const

bool	IdIsNotNil () const

bool	IdIsSet () const

const ON_UUID &	IfIdIsNilSetId ()

int	Index () const

int	Index (int unset_index_value) const

bool	IndexIsLocked () const

bool	IndexIsSet () const

unsigned int	InstanceDefinitionModelSerialNumber () const

bool	IsDeleted () const

bool	IsHidden () const

bool	IsLocked () const

bool	IsReferenceComponent () const

bool	IsSystemComponent () const

bool	IsValid (class ON_TextLog *text_log=nullptr) const override

void	LockAllSettingsExceptName ()

void	LockComponentType ()

void	LockId ()

void	LockIndex ()

void	LockModelComponentStatus ()

void	LockModelSerialNumber ()

void	LockName ()

void	LockParentId ()

ON_ComponentStatus	ModelComponentStatus () const

bool	ModelComponentStatusIsLocked () const

bool	ModelComponentStatusIsSet () const

ON_UUID	ModelObjectId () const override

unsigned int	ModelSerialNumber () const

bool	ModelSerialNumberIsLocked () const

bool	ModelSerialNumberIsSet () const

const ON_wString	Name () const

const wchar_t *	NameAsPointer () const

const ON_NameHash &	NameHash () const

bool	NameIsEmpty () const

bool	NameIsLocked () const

bool	NameIsNotEmpty () const

bool	NameIsSet () const

const ON_NameHash	NewNameHash (const wchar_t *new_name) const

ON_ModelComponent &	operator= (const ON_ModelComponent &source)

const ON_UUID &	ParentId () const

bool	ParentIdIsLocked () const

bool	ParentIdIsNil () const

bool	ParentIdIsNotNil () const

bool	ParentIdIsSet () const

bool	ReadModelComponentAttributes (class ON_BinaryArchive &archive)

unsigned int	ReferenceModelSerialNumber () const

ON__UINT64	RuntimeSerialNumber () const

const ON_UUID &	SetAndLockId ()

bool	SetAsSystemComponent ()

bool	SetAsUnsetSystemComponent ()

bool	SetComponentType (ON_ModelComponent::Type component_component_type)

bool	SetDeletedModelComponentState (bool bDeleted, class ON_ComponentManifest *manifest)

void	SetHiddenModelComponentState (bool bHidden)

const ON_UUID &	SetId ()

bool	SetId (const ON_UUID &component_id)

bool	SetIdentification (const class ON_ComponentManifestItem &manifest_item, const wchar_t *manifest_name, bool bSetId, bool bParentId, bool bSetName, bool bSetIndex)

bool	SetIndex (int component_index)

bool	SetLocalizedSystemComponentName (const wchar_t *system_component_localized_name)

void	SetLockedModelComponentState (bool bLocked)

bool	SetModelComponentStatus (ON_ComponentStatus component_status)

bool	SetModelSerialNumber (unsigned int model_serial_number)

bool	SetModelSerialNumber (unsigned int model_serial_number, unsigned int reference_model_serial_number, unsigned int instance_definition_model_serial_number)

bool	SetName (const wchar_t *component_name)

bool	SetParentId (const ON_UUID &parent_id)

unsigned int	SizeOf () const override

bool	UndeleteName ()

bool	WriteModelComponentAttributes (class ON_BinaryArchive &archive, unsigned int attributes_filter) const

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 ()

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)

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

Static Public Member Functions
static const ON_EmbeddedFile *	FromModelComponentRef (const ON_ModelComponentReference &ref, const ON_EmbeddedFile *none_return_value)

Static Public Member Functions inherited from ON_ModelComponent
static int	CompareId (const ON_ModelComponent &a, const ON_ModelComponent &b)

static int	CompareIdAndName (const ON_ModelComponent &a, const ON_ModelComponent &b)

static int	CompareName (const ON_ModelComponent &a, const ON_ModelComponent &b)

static int	CompareNameAndId (const ON_ModelComponent &a, const ON_ModelComponent &b)

static int	CompareNameExact (const ON_ModelComponent &a, const ON_ModelComponent &b)

static ON_ModelComponent::Type	ComponentTypeFromUnsigned (unsigned int component_type_as_unsigned)

static bool	ComponentTypeIsValid (ON_ModelComponent::Type component_type)

static bool	ComponentTypeIsValidAndNotMixed (ON_ModelComponent::Type component_type)

static const ON_wString	ComponentTypeToString (ON_ModelComponent::Type)

static bool	IndexRequired (ON_ModelComponent::Type component_type)

static unsigned int	Internal_SystemComponentHelper ()
	For internal use. Never call this function. More...

static const wchar_t *	IsNamePathSeparator (const wchar_t *s)

static const wchar_t	IsReferencePrefixDelimiter (const wchar_t *s)

static const wchar_t *	IsReferencePrefixSeparator (const wchar_t *s)

static bool	IsValidComponentName (const class ON_ComponentManifest &model_manfest, const ON_ModelComponent &model_component, bool bPermitReferencePrefix, ON_wString &valid_name)

static bool	IsValidComponentName (const ON_wString &candidate_component_name)

static bool	IsValidComponentName (const wchar_t *candidate_component_name)

static bool	IsValidComponentName (size_t length, const wchar_t *candidate_component_name)

static bool	IsValidComponentNameFirstCodePoint (int length, const wchar_t *candidate_component_name)

static bool	IsValidComponentNameFirstCodePoint (ON__UINT32 unicode_code_point)

static const ON_wString	NameLeaf (const wchar_t *name)

static const ON_wString	NameParent (const wchar_t *name, bool bIncludeReference)

static const ON_wString	NameReferencePrefix (const wchar_t *name)

static ON__UINT64	NextRuntimeSerialNumber ()

static const ON_wString	RemoveAllReferencePrefixDelimiters (const wchar_t *name)

static const ON_wString	RemoveReferencePrefix (const wchar_t *name)

static const ON_wString	RemoveTrailingNamePathSeparator (const wchar_t *name)

static const ON_wString	RemoveTrailingReferencePrefixDelimiter (const wchar_t *name)

static const ON_wString	RemoveTrailingReferencePrefixSeparator (const wchar_t *name)

static void	SplitName (const wchar_t *name, ON_wString &reference_prefix, ON_wString &name_parent, ON_wString &name_leaf)

static bool	UniqueNameIgnoresCase (ON_ModelComponent::Type component_type)

static bool	UniqueNameIncludesParent (ON_ModelComponent::Type component_type)

static bool	UniqueNameRequired (ON_ModelComponent::Type component_type)

Additional Inherited Members
Public Types inherited from ON_ModelComponent
enum	Attributes : unsigned int { NoAttributes = 0U, ComponentSerialNumberAttribute = 0x0001U, TypeAttribute = 0x0002U, ModelSerialNumberAttribute = 0x0004U, IdAttribute = 0x0008U, IndexAttribute = 0x0010U, NameAttribute = 0x0020U, ParentIdAttribute = 0x0040U, DeletedNameAttribute = 0x0080U, ComponentStatusAttribute = 0x0100U, BinaryArchiveAttributes = 0x78U, AllAttributes = 0x1FFU, SystemComponentAttribute = 0x8000U }

enum	Type : unsigned char { Type::Unset = 0, Type::Image = 1, Type::TextureMapping = 2, Type::Material = 3, Type::RenderMaterial = Material, Type::LinePattern = 4, Type::Layer = 5, Type::Group = 6, Type::TextStyle = 7, Type::DimStyle = 8, Type::RenderLight = 9, Type::HatchPattern = 10, Type::InstanceDefinition = 11, Type::ModelGeometry = 12, Type::HistoryRecord = 13, Type::RenderContent = 14, Type::EmbeddedFile = 15, Type::ObsoleteValue = 16, Type::SectionStyle = 17, Type::NumOf, Type::Mixed = 0xFE }
	The ON_ModelComponent::Type enum has a value for each explicit component type and two special values, Unset and Mixed. Use an ON_ModelComponentTypeIterator instance to iterate over the ON_ModelComponent::Type values. /summary> More...

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 }

Static Public Attributes inherited from ON_ModelComponent
static const ON_wString	NamePathSeparator

static const ON_wString	ReferencePrefixDelimiter

static const ON_wString	ReferencePrefixSeparator

static const ON_ModelComponent	Unset

static const ON_wString WorksessionReferencePrefix const	wchar_t

Protected Member Functions inherited from ON_ModelComponent
void	IncrementContentVersionNumber () const

Detailed Description

THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT EXPRESS OR IMPLIED WARRANTY. ALL IMPLIED WARRANTIES OF FITNESS FOR ANY PARTICULAR PURPOSE AND OF MERCHANTABILITY ARE HEREBY DISCLAIMED.

For complete openNURBS copyright information see http://www.opennurbs.org.

Constructor & Destructor Documentation

◆ ON_EmbeddedFile() [1/2]

ON_EmbeddedFile::ON_EmbeddedFile ( )

◆ ON_EmbeddedFile() [2/2]

ON_EmbeddedFile::ON_EmbeddedFile ( const ON_EmbeddedFile & )

◆ ~ON_EmbeddedFile()

virtual ON_EmbeddedFile::~ON_EmbeddedFile ( )

virtual

Member Function Documentation

◆ Clear()

virtual bool ON_EmbeddedFile::Clear ( void )

virtual

Clears the embedded file data. Returns true if successful, else false.

◆ CompressedLength()

virtual size_t ON_EmbeddedFile::CompressedLength ( void ) const

virtual

Returns the compressed length of the data loaded by Read(). If the object is not loaded or was loaded by LoadFromFile() or LoadFromBuffer(), this method returns zero.

◆ Error()

bool ON_EmbeddedFile::Error ( void ) const

Returns true if the embedded file was loaded, but the load failed. This should only happen if a buffer or archive being loaded is corrupted.

◆ EVF()

virtual void* ON_EmbeddedFile::EVF	(	const wchar_t *	func,
		void *	data
	)

virtual

Emergency virtual function for future expansion.

◆ Filename()

virtual ON_wString ON_EmbeddedFile::Filename ( void ) const

virtual

Returns the fully-qualified filename of the embedded file. This filename may or may not refer to a local file depending on the way the embedded file was loaded. For example, if it was loaded from an archive, the filename could be that of a file on a different computer.

◆ FromModelComponentRef()

static const ON_EmbeddedFile* ON_EmbeddedFile::FromModelComponentRef	(	const ON_ModelComponentReference &	ref,
		const ON_EmbeddedFile *	none_return_value
	)

static

If ON_EmbeddedFile::Cast(ref.ModelComponent()) is not null, that pointer is returned. Otherwise, none_return_value is returned.

◆ Length()

virtual size_t ON_EmbeddedFile::Length ( void ) const

virtual

Returns the length of the loaded data. If the object is not loaded, this method returns zero.

◆ LoadFromBuffer()

virtual bool ON_EmbeddedFile::LoadFromBuffer ( ON_Buffer & buf )

virtual

Loads the embedded file from a buffer. This does not set the filename; it merely loads the contents of the buffer into the embedded file object. If you intend to call Write() after this, you may need to call SetFilename() first. Returns true if successful, else false.

◆ LoadFromFile()

virtual bool ON_EmbeddedFile::LoadFromFile ( const wchar_t * filename )

virtual

Loads the embedded file from a local file. This also sets the filename. Returns true if successful, else false.

◆ operator=()

virtual const ON_EmbeddedFile& ON_EmbeddedFile::operator= ( const ON_EmbeddedFile & )

virtual

◆ Read()

virtual bool ON_EmbeddedFile::Read ( ON_BinaryArchive & archive )

overridevirtual

Reads an embedded file from an archive. The archive must be positioned at the start of suitable data as created by the Write() method. It first loads the filename from the archive and then loads the file contents. This method is an expert user tool. Incorrect use will have undefined results. Returns true if successful, else false.

Reimplemented from ON_Object.

◆ SaveToBuffer()

virtual bool ON_EmbeddedFile::SaveToBuffer ( ON_Buffer & buf ) const

virtual

Saves the embedded file to a buffer. The embedded file must have been loaded by a call to one of either LoadFromFile(), LoadFromBuffer() or Read() prior to calling this method. This does not save the filename to the buffer, it only saves the file contents. Returns true if successful, else false.

◆ SaveToFile()

virtual bool ON_EmbeddedFile::SaveToFile ( const wchar_t * filename ) const

virtual

Saves the embedded file to a local file. The embedded file must have been loaded by a call to one of either LoadFromFile(), LoadFromBuffer() or Read() prior to calling this method. Returns true if successful, else false.

◆ SetFilename()

virtual void ON_EmbeddedFile::SetFilename ( const wchar_t * filename )

virtual

Sets the fully-qualified filename of the embedded file. This can be used to set a filename initially when none has been loaded, or to change the filename prior to saving to an archive.

◆ Write()

virtual bool ON_EmbeddedFile::Write ( ON_BinaryArchive & archive ) const

overridevirtual

Writes the embedded file to an archive. The embedded file must have been loaded by a call to one of either LoadFromFile(), LoadFromBuffer() or Read() prior to calling this method. This writes both the filename and the file contents to the archive. Returns true if successful, else false.

Reimplemented from ON_Object.

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ON_EmbeddedFile() [1/2]

◆ ON_EmbeddedFile() [2/2]

◆ ~ON_EmbeddedFile()

Member Function Documentation

◆ Clear()

◆ CompressedLength()

◆ Error()

◆ EVF()

◆ Filename()

◆ FromModelComponentRef()

◆ Length()

◆ LoadFromBuffer()

◆ LoadFromFile()

◆ operator=()

◆ Read()

◆ SaveToBuffer()

◆ SaveToFile()

◆ SetFilename()

◆ Write()