NXOpen::AME::EplanSettingsBuilder Class Reference

EplanSettingsBuilder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateEplanSettingsBuilder

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::AME::EplanSettingsBuilder:

Public Member Functions
NXString	Commission ()
	Returns the commission Created in NX11.0.0. More...
NXString	ControlVoltage ()
	Returns the control voltage Created in NX11.0.0. More...
NXString	Customer ()
	Returns the customer Created in NX11.0.0. More...
NXString	Description ()
	Returns the description Created in NX11.0.0. More...
std::vector< NXString >	GetDetails ()
	Returns the details. More...
NXString	Id ()
	Returns the id Created in NX11.0.0. More...
NXString	Location ()
	Returns the location Created in NX11.0.0. More...
NXString	ManufacturingYear ()
	Returns the manufacturing year Created in NX11.0.0. More...
NXString	Name ()
	Returns the name Created in NX11.0.0. More...
NXString	PowerInput ()
	Returns the power input Created in NX11.0.0. More...
NXString	ProjectTargetPath ()
	Returns the generation path Created in NX11.0.0. More...
NXString	ProjectTemplateFile ()
	Returns the project template file Created in NX11.0.0. More...
void	ResetProjectTemplate ()
	Reset the eplan project template information Created in NX11.0.0. More...
void	SetCommission (const NXString &commission)
	Sets the commission Created in NX11.0.0. More...
void	SetCommission (const char *commission)
	Sets the commission Created in NX11.0.0. More...
void	SetControlVoltage (const NXString &controlVoltage)
	Sets the control voltage Created in NX11.0.0. More...
void	SetControlVoltage (const char *controlVoltage)
	Sets the control voltage Created in NX11.0.0. More...
void	SetCustomer (const NXString &customer)
	Sets the customer Created in NX11.0.0. More...
void	SetCustomer (const char *customer)
	Sets the customer Created in NX11.0.0. More...
void	SetDescription (const NXString &description)
	Sets the description Created in NX11.0.0. More...
void	SetDescription (const char *description)
	Sets the description Created in NX11.0.0. More...
void	SetDetails (const std::vector< NXString > &details)
	Sets the details Created in NX11.0.0. More...
void	SetId (const NXString &id)
	Sets the id Created in NX11.0.0. More...
void	SetId (const char *id)
	Sets the id Created in NX11.0.0. More...
void	SetLocation (const NXString &location)
	Sets the location Created in NX11.0.0. More...
void	SetLocation (const char *location)
	Sets the location Created in NX11.0.0. More...
void	SetManufacturingYear (const NXString &manufacturingYear)
	Sets the manufacturing year Created in NX11.0.0. More...
void	SetManufacturingYear (const char *manufacturingYear)
	Sets the manufacturing year Created in NX11.0.0. More...
void	SetName (const NXString &name)
	Sets the name Created in NX11.0.0. More...
void	SetName (const char *name)
	Sets the name Created in NX11.0.0. More...
void	SetPowerInput (const NXString &powerInput)
	Sets the power input Created in NX11.0.0. More...
void	SetPowerInput (const char *powerInput)
	Sets the power input Created in NX11.0.0. More...
void	SetProjectTargetPath (const NXString &projectTargetPath)
	Sets the generation path Created in NX11.0.0. More...
void	SetProjectTargetPath (const char *projectTargetPath)
	Sets the generation path Created in NX11.0.0. More...
void	SetProjectTemplateFile (const NXString &filename)
	Sets the project template file Created in NX11.0.0. More...
void	SetProjectTemplateFile (const char *filename)
	Sets the project template file Created in NX11.0.0. More...
Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...
void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...
std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...
NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...
void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

EplanSettingsBuilder
To create a new instance of this class, use NXOpen::AME::AMEManager::CreateEplanSettingsBuilder

Created in NX11.0.0.

Member Function Documentation

NXString NXOpen::AME::EplanSettingsBuilder::Commission

(

)

Returns the commission
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::ControlVoltage

(

)

Returns the control voltage
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::Customer

(

)

Returns the customer
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::Description

(

)

Returns the description
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

std::vector<NXString> NXOpen::AME::EplanSettingsBuilder::GetDetails

(

)

Returns the details.

Returns

Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::Id

(

)

Returns the id
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::Location

(

)

Returns the location
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::ManufacturingYear

(

)

Returns the manufacturing year
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::Name

(

)

Returns the name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::PowerInput

(

)

Returns the power input
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::ProjectTargetPath

(

)

Returns the generation path
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

NXString NXOpen::AME::EplanSettingsBuilder::ProjectTemplateFile

(

)

Returns the project template file
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::EplanSettingsBuilder::ResetProjectTemplate

(

)

Reset the eplan project template information
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

void NXOpen::AME::EplanSettingsBuilder::SetCommission

(

const NXString &

commission

)

Sets the commission
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

commission

commission

void NXOpen::AME::EplanSettingsBuilder::SetCommission

(

const char *

commission

)

Sets the commission
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

commission

commission

void NXOpen::AME::EplanSettingsBuilder::SetControlVoltage

(

const NXString &

controlVoltage

)

Sets the control voltage
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

controlVoltage

controlvoltage

void NXOpen::AME::EplanSettingsBuilder::SetControlVoltage

(

const char *

controlVoltage

)

Sets the control voltage
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

controlVoltage

controlvoltage

void NXOpen::AME::EplanSettingsBuilder::SetCustomer

(

const NXString &

customer

)

Sets the customer
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

customer

customer

void NXOpen::AME::EplanSettingsBuilder::SetCustomer

(

const char *

customer

)

Sets the customer
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

customer

customer

void NXOpen::AME::EplanSettingsBuilder::SetDescription

(

const NXString &

description

)

Sets the description
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

description

description

void NXOpen::AME::EplanSettingsBuilder::SetDescription

(

const char *

description

)

Sets the description
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

description

description

void NXOpen::AME::EplanSettingsBuilder::SetDetails

(

const std::vector< NXString > &

details

)

Sets the details
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

details

details

void NXOpen::AME::EplanSettingsBuilder::SetId

(

const NXString &

id

)

Sets the id
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

id

id

void NXOpen::AME::EplanSettingsBuilder::SetId

(

const char *

id

)

Sets the id
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

id

id

void NXOpen::AME::EplanSettingsBuilder::SetLocation

(

const NXString &

location

)

Sets the location
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

location

location

void NXOpen::AME::EplanSettingsBuilder::SetLocation

(

const char *

location

)

Sets the location
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

location

location

void NXOpen::AME::EplanSettingsBuilder::SetManufacturingYear

(

const NXString &

manufacturingYear

)

Sets the manufacturing year
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

manufacturingYear

manufacturingyear

void NXOpen::AME::EplanSettingsBuilder::SetManufacturingYear

(

const char *

manufacturingYear

)

Sets the manufacturing year
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

manufacturingYear

manufacturingyear

void NXOpen::AME::EplanSettingsBuilder::SetName

(

const NXString &

name

)

Sets the name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

name

name

void NXOpen::AME::EplanSettingsBuilder::SetName

(

const char *

name

)

Sets the name
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

name

name

void NXOpen::AME::EplanSettingsBuilder::SetPowerInput

(

const NXString &

powerInput

)

Sets the power input
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

powerInput

powerinput

void NXOpen::AME::EplanSettingsBuilder::SetPowerInput

(

const char *

powerInput

)

Sets the power input
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

powerInput

powerinput

void NXOpen::AME::EplanSettingsBuilder::SetProjectTargetPath

(

const NXString &

projectTargetPath

)

Sets the generation path
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

projectTargetPath

projecttargetpath

void NXOpen::AME::EplanSettingsBuilder::SetProjectTargetPath

(

const char *

projectTargetPath

)

Sets the generation path
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

projectTargetPath

projecttargetpath

void NXOpen::AME::EplanSettingsBuilder::SetProjectTemplateFile

(

const NXString &

filename

)

Sets the project template file
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

filename

filename

void NXOpen::AME::EplanSettingsBuilder::SetProjectTemplateFile

(

const char *

filename

)

Sets the project template file
Created in NX11.0.0.

License requirements : ad_automation_design ("FULL AUTOMATION DESIGNER")

Parameters

filename

filename

---

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

• AME_EplanSettingsBuilder.hxx